Remove backup_changelists option (#193)

Author: ca-johnson

README.md

@@ -74,17 +74,6 @@ view: >-
 
 ### Advanced
 
-#### `backup_changelists` (optional, bool)
-
-Default: `no`.
-
-When running a build against a shelved changelist, create a duplicate of that changelist so that other steps in the build are guaranteed to run against the same version of shelved files.
-
-Caveats:
-
-* May lead to accumulation of many shelved changelists on the server, affecting performance.
-* Removes convenience of being able to re-shelve changes and iterate by retrying only failied steps.
-
 #### `client_options` (optional, string)
 
 Default: `clobber`.

plugin.yml

@@ -3,8 +3,6 @@ description: Checks out a perforce repository instead of git.
 author: https://github.com/ca-johnson
 configuration:
   properties:
-    backup_changelists:
-      type: bool
     client_options:
       type: string
     client_type:

python/buildkite.py

@@ -13,8 +13,6 @@
 
 __REVISION_METADATA__ = 'buildkite-perforce-revision'
 __REVISION_METADATA_DEPRECATED__ = 'buildkite:perforce:revision' # old metadata key, incompatible with `bk local run`
-__SHELVED_METADATA__ = 'buildkite-perforce-shelved'
-__SHELVED_ANNOTATION__ = "Saved shelved change {original} as {copy}"
 
 def get_env():
     """Get env vars passed in via plugin config"""
@@ -65,9 +63,6 @@ def get_config():
     conf['view'] = ['%s %s' % (v, next(view_iter)) for v in view_iter]
     return conf
 
-def should_backup_changelists():
-    return os.environ.get('BUILDKITE_PLUGIN_PERFORCE_BACKUP_CHANGELISTS', 'false') == 'true'
-
 def get_metadata(key):
     """If it exists, retrieve metadata from buildkite for a given key"""
     if not __ACCESS_TOKEN__:
@@ -101,23 +96,6 @@ def get_users_changelist():
     if branch.isdigit():
         return branch
 
-def get_build_changelist():
-    """Get a saved version of the users originally supplied changelist, if available"""
-    return get_metadata(__SHELVED_METADATA__)
-
-def set_build_changelist(changelist):
-    """Set a shelved change that should be used instead of the user-supplied one"""
-    if set_metadata(__SHELVED_METADATA__, changelist) and should_backup_changelists():
-        subprocess.call([
-            'buildkite-agent', 'annotate',
-            __SHELVED_ANNOTATION__.format(**{
-                'original': get_users_changelist(),
-                'copy': changelist,
-            }),
-            '--context', __SHELVED_METADATA__,
-            '--style', 'info',
-        ])
-
 def get_build_revision():
     """Get a p4 revision for the build from buildkite context"""
     revision = get_metadata(__REVISION_METADATA__) or \

python/checkout.py

@@ -7,8 +7,7 @@
 
 from perforce import P4Repo
 from buildkite import (get_env, get_config, get_build_revision, set_build_revision,
-    get_users_changelist, get_build_changelist, set_build_changelist, set_build_info,
-    should_backup_changelists)
+    get_users_changelist, set_build_info)
 
 def main():
     """Main"""
@@ -26,19 +25,11 @@ def main():
 
     user_changelist = get_users_changelist()
     if user_changelist:
-        # Use existing or make a copy of the users changelist for this build
-        changelist = get_build_changelist()
-        if not changelist:
-            changelist = user_changelist
-            if should_backup_changelists():
-                changelist = repo.backup(user_changelist)
-            set_build_changelist(changelist)
-
-        repo.p4print_unshelve(changelist)
+        repo.p4print_unshelve(user_changelist)
 
     description = repo.description(
         # Prefer users change description over latest submitted change
-        get_users_changelist() or repo.head_at_revision(revision)
+        user_changelist or repo.head_at_revision(revision)
     )
     set_build_info(revision, description)
 

python/perforce.py

@@ -245,27 +245,6 @@ def revert(self):
             self.perforce.run_clean(patched)
             os.remove(self.patchfile)
 
-    def unshelve(self, changelist):
-        """Unshelve a pending change"""
-        self._setup_client()
-
-        changeinfo = self.perforce.run_describe('-S', changelist)
-        if not changeinfo:
-            raise Exception('Changelist %s does not contain any shelved files.' % changelist)
-        changeinfo = changeinfo[0]
-
-        # Reject exclusive lock files for now
-        modifiers = [filetype.split('+')[1]
-                     for filetype in changeinfo['type']
-                     if '+' in filetype]
-        if any('l' in modifier for modifier in modifiers):
-            raise Exception(
-                'You cannot run a presubmit test with exclusive lock files (+l) at this time\n'
-                'See https://github.com/ca-johnson/perforce-buildkite-plugin/issues/102 for latest status\n')
-
-
-        self.perforce.run_unshelve('-s', changelist)
-
     def run_parallel_cmds(self, cmds, max_parallel=20):
         def run(*args):
             """Acquire new connection and run p4 cmd"""
@@ -310,19 +289,6 @@ def p4print_unshelve(self, changelist):
 
         self.run_parallel_cmds(cmds)
 
-    def backup(self, changelist):
-        """Make a copy of a shelved change"""
-        self.revert()
-        self.unshelve(changelist)
-        # Make pending CL from default CL
-        unshelved = self.perforce.fetch_change()
-        unshelved._description = 'Backup of %s for precommit testing in Buildkite' % changelist
-        self.perforce.save_change(unshelved)
-        backup_change_info = self.perforce.run_changes('-c', self.perforce.client, '-s', 'pending', '-m', '1')
-        backup_cl = backup_change_info[0]['change']
-        self.perforce.run_shelve('-c', backup_cl)
-        return backup_cl
-
 
 class SyncOutput(OutputHandler):
     """Log each synced file"""

python/test_perforce.py

@@ -316,35 +316,6 @@ def test_workspace_recovery(server, tmpdir):
     assert sorted(os.listdir(tmpdir)) == sorted([
         "file.txt", "p4config"]), "Failed to restore corrupt workspace due to missing p4config"
 
-def test_unshelve(server, tmpdir):
-    """Test unshelving a pending changelist"""
-    repo = P4Repo(root=tmpdir)
-    repo.sync()
-    with open(os.path.join(tmpdir, "file.txt")) as content:
-        assert content.read() == "Hello World\n", "Unexpected content in workspace file"
-
-    repo.unshelve('3') # Modify a file
-    with open(os.path.join(tmpdir, "file.txt")) as content:
-        assert content.read() == "Goodbye World\n", "Unexpected content in workspace file"
-    repo.sync()
-
-    repo.unshelve('4') # Delete a file
-    assert not os.path.exists(os.path.join(tmpdir, "file.txt"))
-    repo.sync()
-
-    repo.unshelve('5') # Add a file
-    assert os.path.exists(os.path.join(tmpdir, "newfile.txt"))
-    repo.sync()
-
-    with pytest.raises(Exception, match=r'Changelist 999 does not contain any shelved files.'):
-        repo.unshelve('999')
-
-    # Unshelved changes are removed in following syncs
-    repo.sync()
-    with open(os.path.join(tmpdir, "file.txt")) as content:
-        assert content.read() == "Hello World\n", "Unexpected content in workspace file"
-    assert not os.path.exists(os.path.join(tmpdir, "newfile.txt")), "File unshelved for add was not deleted"
-
 def test_p4print_unshelve(server, tmpdir):
     """Test unshelving a pending changelist by p4printing content into a file"""
     repo = P4Repo(root=tmpdir)
@@ -383,16 +354,6 @@ def test_p4print_unshelve(server, tmpdir):
     repo = P4Repo(root=tmpdir, stream='//stream-depot/main')
     repo.p4print_unshelve('3') # Modify a file
 
-def test_backup_shelve(server, tmpdir):
-    """Test making a copy of a shelved changelist"""
-    repo = P4Repo(root=tmpdir)
-
-    backup_changelist = repo.backup('3')
-    assert backup_changelist != '3', "Backup changelist number must be new"
-    repo.revert()
-    repo.unshelve(backup_changelist)
-    with open(os.path.join(tmpdir, "file.txt")) as content:
-        assert content.read() == "Goodbye World\n", "Unexpected content in workspace file"
 
 def copytree(src, dst):
     """Shim to get around shutil.copytree requiring root dir to not exist"""