Repo tag test failure fix (#86)

* Use a git log command that works on git 1.8.x and 2.x

* Use a git log command that works on git 1.8.x and 2.x

* Use a git log command that works on git 1.8.x and 2.x

* Use a git log command that works on git 1.8.x and 2.x

* Use a git log command that works on git 1.8.x and 2.x

* Add type check fixes.

* Add type check fixes.

* build fix

* build fix

* build fix

* Add release tagging

* Add release tagging

Minor updates

* Add release tagging

* Add release tagging

* Bandit checks

* Git tagging fix

* Git tagging fix

* Git tagging fix

* Make tagging work if ssh is setup by the screwdriver server setup.

* Support the old package publish environment setting variable so old templates don't break.

* Don't run the validation on centos 5 since it doesn't work.

* Don't run the validation on centos 5 since it doesn't work.

* Remove debug print

* Don't override the package version

* Display a message when changing the metadata in screwdriver.

* - Make the release tagger use the Versioner class to get the metadata version so there aren't
multiple implementations of the same thing.
- Update the Versioner base class to allow specifying the meta command as an argument.  To simplify writing tests.

Author: dwighthubbard

screwdriver.yaml

@@ -64,11 +64,6 @@ jobs:
         template: python/validate_pypi_package
         environment:
             PYPI_INDEX_URL: https://test.pypi.org/simple
-        steps:
-            - update_version: |
-                PACKAGE_VERSION="`meta get package.version`"
-                echo $PACKAGE_VERSION
-            - preend: meta set package.version "$PACKAGE_VERSION"
         requires: [publish_test_pypi]
 
     publish_pypi:

src/screwdrivercd/repo/release.py

@@ -11,6 +11,7 @@
 
 from ..changelog.generate import changelog_contents
 from ..utility.environment import env_bool
+from ..version.version_types import Version
 
 
 def create_release_tag(version: str, git_command: str='git', message: str=''):
@@ -50,12 +51,13 @@ def main(meta_command: str='meta') -> int:
         print('Tagging is disabled for this job')
         return 0
 
-    if not os.environ.get('GIT_DEPLOY_KEY', '') and not os.environ.get('SSH_AUTH_SOCK', ''):
-        print('Git deployment key is not present, cannot commit tags to the git repo')
-        return 0
+    if not os.environ.get('SSH_AUTH_SOCK', ''):  # If ssh-agent isn't already configured, we use the GIT_DEPLOY_KEY
+        if not os.environ.get('GIT_DEPLOY_KEY', ''):
+            print('Git deployment key is not present, cannot commit tags to the git repo')
+            return 0
 
-    version = subprocess.check_output([meta_command, 'get', 'package.version']).decode(errors='ignore').strip()  # nosec
-    if version == 'null':  # pragma: no cover
+    version = Version(meta_command=meta_command).meta_version
+    if not version:  # pragma: no cover
         print('No release version in metadata', flush=True)
         return 0
 

src/screwdrivercd/version/version_types.py

@@ -13,17 +13,19 @@
 LOG = logging.getLogger(__name__)
 
 
-class Version:
+class Version():
     """
     Base Screwdriver Versioning class
     """
     name: Union[str, None] = None
     default_version: List[str] = ['0', '0', '0']
     setup_cfg_filename: str = 'setup.cfg'
+    _meta_version: str = ''
 
-    def __init__(self, setup_cfg_filename=None, ignore_meta_version=False, update_sdv4_meta=True):
+    def __init__(self, setup_cfg_filename=None, ignore_meta_version: bool=False, update_sdv4_meta: bool=True, meta_command: str='meta'):
         if setup_cfg_filename:  # pragma: no cover
             self.setup_cfg_filename = setup_cfg_filename
+        self.meta_command = meta_command
         self.ignore_meta_version = ignore_meta_version
         self.update_sdv4_meta = update_sdv4_meta
 
@@ -89,9 +91,11 @@ def update_meta_version(self):  # noqa
         """
         if not self.meta_version:  # pragma: no cover
             if not self.pull_request_number:
-                self.meta_version = self.generated_version
+                new_version = self.generated_version
             else:  # pragma: no cover
-                self.meta_version = f'{self.generated_version}a{self.pull_request_number}'
+                new_version = f'{self.generated_version}a{self.pull_request_number}'
+            print(f'Updating the screwdriver metadata: package.version={new_version}', flush=True)
+            self.meta_version = new_version
 
     @property
     def pull_request_number(self):
@@ -118,28 +122,31 @@ def generated_version(self):
         return '.'.join(self.generate())
 
     @property
-    def meta_version(self):
+    def meta_version(self) -> str:
         """
         The version from the screwdriver metadata package.version value or None if not present.
         """
         if self.ignore_meta_version:
-            return None
+            return ''
+        if self._meta_version:
+            return self._meta_version
         try:  # pragma: no cover
-            version = subprocess.check_output(['meta', 'get', 'package.version']).decode(errors='ignore').strip()  # nosec
-        except FileNotFoundError:  # pragma: no cover
-            version = None
-        if not version or version == 'null':  # pragma: no cover
-            version = None
-        return version  # pragma: no cover
+            self._meta_version = subprocess.check_output([self.meta_command, 'get', 'package.version']).decode(errors='ignore').strip()  # nosec
+        except (FileNotFoundError, subprocess.CalledProcessError):  # pragma: no cover
+            pass
+        if self._meta_version == 'null':
+            self._meta_version = ''
+        return self._meta_version  # pragma: no cover
 
     @meta_version.setter
     def meta_version(self, new_version):
         if not self.update_sdv4_meta:  # pragma: no cover
             return
         try:
-            subprocess.check_call(['meta', 'set', 'package.version', new_version])  # nosec
+            subprocess.check_call([self.meta_command, 'set', 'package.version', new_version])  # nosec
         except FileNotFoundError:  # pragma: no cover
             LOG.warning('The screwdriver meta command is missing, unable to set version in screwdriver metadata')
+        self._meta_version = new_version
 
     @property
     def version(self):

tests/test_repo.py

@@ -90,7 +90,6 @@ def test__release__main__package_tag__disabled(self):
     def test__release__main__git_deploy_key__missing(self):
         os.environ['PUBLISH'] = 'True'
         os.environ['PACKAGE_TAG'] = 'True'
-        os.environ['GIT_DEPLOY_KEY'] = ''
         result = release_main()
         self.assertEqual(result, 0)