Merge pull request #144 from steinwurf/ctx.project_version

added project_version as a function on the context

NEWS.rst

@@ -6,6 +6,7 @@ of every change, see the Git log.
 
 Latest
 ------
+* Minor: Added project_version as a function on the Context object.
 * Patch: Added dependency paths for resolve conflicts.
 * Patch: Fix ``--no_resolve`` option.
 * Minor: Change output so that the resolve path is printed instead of the

src/wurf/git.py

@@ -256,3 +256,12 @@ def default_branch(self, cwd):
         output = self.ctx.cmd_and_log(args, cwd=cwd)
 
         return output.strip().split("/")[-1]
+
+    def is_dirty(self, cwd):
+        """
+        Returns True if the repository in directory cwd has uncommitted changes.
+        """
+        args = [self.git_binary, "status", "--porcelain"]
+        output = self.ctx.cmd_and_log(args, cwd=cwd)
+
+        return output != ""

src/wurf/waf_conf.py

@@ -7,6 +7,7 @@
 # wscripts.
 
 import sys
+import os
 
 from waflib.Configure import conf
 from waflib.Errors import WafError
@@ -18,6 +19,8 @@
 from . import virtualenv
 from . import rewrite
 from . import pip_tools
+from . import error
+from .registry import Registry
 
 
 def extend_context(f):
@@ -151,3 +154,72 @@ def ensure_build(ctx):
 @extend_context
 def rewrite_file(ctx, filename):
     return rewrite.rewrite_file(filename=filename)
+
+
+@extend_context
+def project_version(ctx):
+    """
+    Return the project version. If the project is not a git repository
+    None is returned. If the project is a git repository the version
+    is constructed as follows:
+
+    1. If the current commit matches a tag the tag is used as the version.
+    2. If the current commit does not match a tag the latest tag and
+       current commit is used as the version.
+    3. If the repository contains uncommitted changes "-dirty" is appended.
+
+    Examples:
+
+        gc0b0b0b
+        gc0b0b0b-dirty
+        1.0.0
+        1.0.0-dirty
+        1.0.0-gc0b0b0b
+        1.0.0-gc0b0b0b-dirty # all together now
+
+    :param ctx: A Waf Context instance.
+    """
+
+    # To avoid logs going to stdout create an logger
+    bldnode = ctx.path.make_node("build")
+    bldnode.mkdir()
+
+    log_path = os.path.join(bldnode.abspath(), "version.log")
+
+    ctx.logger = Logs.make_logger(path=log_path, name="version")
+    ctx.logger.debug("wurf: project version execute")
+
+    registry = Registry()
+    registry.provide_value("ctx", ctx)
+    registry.provide_value("git_binary", "git")
+    git = registry.require("git")
+
+    try:
+        # Build the registry
+        cwd = ctx.path.abspath()
+        if not git.is_git_repository(cwd):
+            return None
+
+        commit = git.current_commit(cwd)
+        tag = ([None] + git.tags(cwd))[-1]
+        if tag is not None:
+            tag = tag.rstrip()
+            tag_commit = git.checkout_to_commit_id(cwd, tag)
+            if tag_commit == commit:
+                commit = None
+        dirty = git.is_dirty(cwd)
+
+        # Build the version slug
+        version = []
+        if tag is not None:
+            version.append(tag)
+        if commit is not None:
+            version.append(commit[:7])
+        if dirty:
+            version.append("dirty")
+        version = "-".join(version)
+
+        return version
+    except error.CmdAndLogError as e:
+        ctx.logger.debug(f"wurf: project version failed: {e}")
+        return None

src/wurf/waf_resolve_context.py

@@ -105,6 +105,11 @@ def execute(self):
         self.logger = Logs.make_logger(path, "resolve")
         self.logger.debug(f"wurf: Resolve execute {configuration.resolver_chain()}")
 
+        # Print the project version
+        self.start_msg("Project version")
+        version = self.project_version()
+        self.end_msg(version or "unknown", color="GREEN" if version else "YELLOW")
+
         self.dependency_manager: DependencyManager = self.registry.require(
             "dependency_manager"
         )
@@ -189,3 +194,8 @@ def cmd_and_log(self, cmd, **kwargs):
             raise CmdAndLogError(error=e)
         except Exception:
             raise
+
+
+WafResolveContext.__doc__ = (
+    "resolves the dependencies specified in the wscript's resolve function"
+)

src/wurf/waf_standalone_context.py

@@ -6,7 +6,6 @@
 
 
 def options(opt):
-
     opts = opt.add_option_group("Standalone archive options")
 
     opts.add_option(
@@ -62,3 +61,8 @@ def get_files(self):
         )
 
         return self.base_path.ant_glob("**/*", dir=True, excl=excludes.split())
+
+
+WafStandaloneContext.__doc__ = (
+    "creates a standalone archive that contains all dependencies"
+)

test/fake_git.py

@@ -206,3 +206,7 @@ def default_branch(self, cwd):
     def _to_sha1(self, data):
         """Small private helper to calculate SHA1"""
         return hashlib.sha1(data.encode("utf-8")).hexdigest()
+
+    def is_dirty(self, cwd):
+        """Fake whether the repository has uncommitted changes"""
+        return False