core: refactor unreasonable default atomic=False

In the beginning, I assumed most rdopkg actions would use state and
--continue/--abort but that doesn't happen to be the case with only
`rdopkg new-version` using this functionality to handle rebases at the
moment, so I changed both the default and the name to something less cryptic.

continuable=False is the new default for Action() and thus many redundant
'atomic=False' strings were dropped.

    continuable == not atomic

eliminated some negations like

    if not atomic:

in favor of direct

    if continuable:

This is a cleanup of a poor design decision ¯\_(ツ)_/¯

Change-Id: I717f8dedda33d3a43f7326151fd3faf4020f3ade

Author: Jakub Ruzicka

HACKING.md

@@ -128,7 +128,6 @@ that's not the case in the time of writing due to legacy reasons.
 Finally, note that some refactoring is expected before action modules
 interface is stable, not limited to:
 
- * rethink atomic=True which now spams most of actions
  * include full action documentation in `__init__.py` as opposed of having
    only short string there and the rest in doc/ - that's sure to desync over
    time.

doc/rdopkg.1.adoc

@@ -419,7 +419,7 @@ ACTION: amend
 Amend last git commit with current dist-git changes and (re)generate the commit
 message from %changelog.
 
-This simple atomic action is equivalent to running
+This simple action is equivalent to running
 
     git commit -a --amend -m "$AUTOMAGIC_COMMIT_MESSAGE"
 
@@ -433,7 +433,7 @@ ACTION: squash
 Squash last git commit into previous one. Commit message of previous commit is
 used.
 
-This simple atomic action is a shortcut for
+This simple action is a shortcut for
 
     git reset --soft HEAD~
     git commit --amend --no-edit

rdopkg/action.py

@@ -21,7 +21,7 @@ def cmdarg_names(self, name2argfun):
 
 
 class Action(object):
-    def __init__(self, name, steps=None, atomic=False, module=None,
+    def __init__(self, name, steps=None, continuable=False, module=None,
                  action_fun=None, required_args=None, optional_args=None,
                  const_args=None, help=None, description=None):
         if not const_args:
@@ -33,7 +33,7 @@ def __init__(self, name, steps=None, atomic=False, module=None,
         self.name = name
         self.module = module
         self.steps = steps
-        self.atomic = atomic
+        self.continuable = continuable
         self.action_fun = action_fun
         self.const_args = const_args
         self.required_args = required_args
@@ -178,7 +178,7 @@ def _get_action_fun(self, action):
     def run_action(self, action, args=None):
         if not args:
             args = {}
-        if not action.atomic:
+        if action.continuable:
             log.info(log.term.bold("## %s" % action.name))
         for carg in action.const_args:
             args[carg] = action.const_args[carg]

rdopkg/actions/build/__init__.py

@@ -2,7 +2,7 @@
 
 
 ACTIONS = [
-    Action('coprbuild', atomic=True, help="build package in copr-jruzicka",
+    Action('coprbuild', help="build package in copr-jruzicka",
            steps=[
                Action('get_package_env', module='distgit'),
                Action('copr_check'),
@@ -18,12 +18,12 @@
                Arg('fuser', shortcut='-u',
                    help="Fedora user to upload srpm as to fedorapeople.org"),
            ]),
-    Action('kojibuild', atomic=True, help="build package in koji",
+    Action('kojibuild', help="build package in koji",
            steps=[
                Action('get_package_env', module='distgit'),
                Action('koji_build'),
            ]),
-    Action('cbsbuild', atomic=True, help="build package in CBS",
+    Action('cbsbuild', help="build package in CBS",
            steps=[
                Action('get_package_env', module='distgit'),
                Action('cbs_build'),
@@ -32,7 +32,7 @@
                Arg('scratch', action='store_true',
                    help='Perform a scratch build'),
            ]),
-    Action('mockbuild', atomic=True, help="Run fedpkg/rhpkg mockbuild",
+    Action('mockbuild', help="Run fedpkg/rhpkg mockbuild",
            steps=[
                Action('get_package_env', module='distgit'),
                Action('fedpkg_mockbuild'),

rdopkg/actions/distgit/__init__.py

@@ -2,7 +2,7 @@
 
 
 ACTIONS = [
-    Action('clone', atomic=True,
+    Action('clone',
            help="clone an RDO package distgit and setup remotes",
            required_args=[
                Arg('package', positional=True, metavar='PACKAGE',
@@ -17,17 +17,17 @@
                Arg('review_user', shortcut='-u', metavar='USER',
                    help="gerrit username for reviews"),
            ]),
-    Action('pkgenv', atomic=True, help="show detected package environment",
+    Action('pkgenv', help="show detected package environment",
            steps=[
                Action('get_package_env'),
                Action('show_package_env'),
            ]),
-    Action('patchlog', atomic=True, help="show patches branch log",
+    Action('patchlog', help="show patches branch log",
            steps=[
                Action('get_package_env'),
                Action('show_patch_log'),
            ]),
-    Action('get-patches', atomic=True,
+    Action('get-patches',
            help="setup local patches branch and switch to it",
            optional_args=[
                Arg('patches_branch', shortcut='-p', metavar='REMOTE/BRANCH',
@@ -55,7 +55,7 @@
                Action('commit_distgit_update'),
                Action('final_spec_diff'),
            ]),
-    Action('patch', atomic=True,
+    Action('patch',
            help="introduce new patches to the package",
            optional_args=[
                Arg('patches_branch', shortcut='-p', metavar='REMOTE/BRANCH',
@@ -91,7 +91,8 @@
                Action('commit_distgit_update', const_args={'amend': True}),
                Action('final_spec_diff'),
            ]),
-    Action('new_version', help="update package to new upstream version",
+    Action('new_version', continuable=True,
+           help="update package to new upstream version",
            optional_args=[
                Arg('new_version', positional=True, nargs='?',
                    help="version to update to"),
@@ -138,7 +139,7 @@
                Action('final_spec_diff'),
                Action('review_patches_branch')
            ]),
-    Action('update_patches', atomic=True,
+    Action('update_patches',
            help='[DEPRECATED] update patches from -patches branch',
            description=(
                "WARNING: This is a low-level action for backward "
@@ -156,20 +157,20 @@
                    metavar='LOCAL_BRANCH',
                    help="local git branch containing patches"),
            ]),
-    Action('amend', atomic=True,
+    Action('amend',
            help="amend last commit and recreate commit message",
            optional_args=[
                Arg('commit_header_file', shortcut='-H', metavar='FILE',
                    help="start commit message with FILE contents, "
                         "- for stdin"),
            ]),
-    Action('squash', atomic=True,
+    Action('squash',
            help="squash HEAD into HEAD~ using HEAD~ commit message"),
-    Action('get_source', atomic=True, help="fetch source archive",
+    Action('get_source', help="fetch source archive",
            steps=[
                Action('get_source', const_args={'new_sources': True})
            ]),
-    Action('tag_patches', atomic=True,
+    Action('tag_patches',
            help='tag the -patches branch in Git with the current NVR',
            optional_args=[
                Arg('force', shortcut='-f', action='store_true',

rdopkg/actions/info/__init__.py

@@ -2,7 +2,7 @@
 
 
 ACTIONS = [
-    Action('info', atomic=True, help="show information about RDO packaging",
+    Action('info', help="show information about RDO packaging",
            optional_args=[
                Arg('pkgs', positional=True, nargs='*', metavar='ATTR:REGEX',
                    help="show info about packages with ATTR matching REGEX"),
@@ -13,15 +13,15 @@
                Arg('local_info', shortcut='-l',
                    help="use local rdoinfo repo found in specified path"),
            ]),
-    Action('info_tags_diff', atomic=True,
+    Action('info_tags_diff',
            help="find which tags have changed between HEAD~..HEAD in rdoinfo",
            optional_args=[
                Arg('local_info', positional=True, metavar='RDOINFODIR',
                    help="use local rdoinfo repo found in RDOINFODIR"),
                Arg('buildsys_tags', shortcut='-b', action='store_true',
                    help="process buildsys-tags instead of regular tags"),
            ]),
-    Action('findpkg', atomic=True,
+    Action('findpkg',
            help="find and show single best matching package in rdoinfo",
            optional_args=[
                Arg('query', positional=True, metavar='PACKAGE/PROJECT/URL',

rdopkg/actions/reqs/__init__.py

@@ -2,7 +2,7 @@
 
 
 ACTIONS = [
-    Action('reqdiff', atomic=True, help="show diff of requirements.txt",
+    Action('reqdiff', help="show diff of requirements.txt",
            steps=[
                Action('get_package_env', module='distgit'),
                Action('get_diff_range', module='distgit'),
@@ -15,7 +15,7 @@
                         "2 args: diff between 1st and 2nd supplied git refs"),
            ],
            ),
-    Action('reqcheck', atomic=True,
+    Action('reqcheck',
            help="inspect requirements.txt vs .spec Requires",
            steps=[
                Action('get_package_env', module='distgit'),
@@ -25,7 +25,7 @@
                Arg('spec', shortcut='-s', action='store_true',
                    help="output .spec Requires: for easy pasting"),
            ]),
-    Action('reqquery', atomic=True,
+    Action('reqquery',
            help="query RDO repos for versions defined in requirements.txt",
            required_args=[
                Arg('filter', positional=True, metavar='RELEASE(/DIST)',
@@ -52,8 +52,8 @@
                Arg('verbose', shortcut='-v', action='store_true',
                    help="print status during queries"),
            ]),
-    Action('query', atomic=True, help="query RDO and distribution repos for "
-                                      "available package versions",
+    Action('query',
+           help="query RDO/dist repos for available package versions",
            optional_args=[
                Arg('filter', positional=True, metavar='RELEASE(/DIST)',
                    help="RDO release(/dist) to query (see `rdopkg info`)"),

rdopkg/actions/review/__init__.py

@@ -9,7 +9,7 @@
                    positional=True, nargs='?',
                    help="local patches branch with changes to review"),
            ]),
-    Action('review_spec', atomic=True,
+    Action('review_spec',
            help="send distgit (.spec file) change for review",
            optional_args=[
                Arg('branch', metavar='DISTGIT_BRANCH',

rdopkg/actions/util/__init__.py

@@ -2,12 +2,12 @@
 
 
 ACTIONS = [
-    Action('status', atomic=True, help="show status of previous action"),
-    Action('conf', atomic=True, help="show rdopkg configuration"),
-    Action('actions', atomic=True,
+    Action('status', help="show status of previous action"),
+    Action('conf', help="show rdopkg configuration"),
+    Action('actions',
            help="list action functions and their availability"),
-    Action('autocomplete', atomic=True,
+    Action('autocomplete',
            help="get TAB completion for rdopkg!"),
-    Action('doctor', atomic=True,
+    Action('doctor',
            help="activate rdopkg psychoanalyst mode"),
 ]

rdopkg/core.py

@@ -28,8 +28,7 @@ def __init__(self, action_manager=None, state_file_path=None):
         self.state_file_path = state_file_path or const.STATE_FILE_FN
 
     def save_state(self):
-        if self.action and self.action[0].atomic:
-            # don't save state for atomic actions
+        if not (self.action and self.action[0].continuable):
             return
         data = {
             'action': self.action_manager.action_serialize(self.action),
@@ -74,7 +73,7 @@ def clear_state(self, state_file=True, verbose=False):
                 print("State file removed.")
 
     def _new_action_check(self, new_action):
-        if self.action and not new_action.atomic:
+        if self.action and new_action.continuable:
             action_name = self.action[0].name
             print(log.term.important(
                   "You're in the middle of previous action: %s\n" %
@@ -105,7 +104,7 @@ def new_action(self, action, args=None):
                     break
         if not self.action:
             raise exception.InvalidAction(action=action)
-        if not action.atomic and action.steps:
+        if not action.continuable and action.steps:
             self.save_state()
 
     def print_progress(self):
@@ -177,10 +176,10 @@ def _check_action(a, indent=''):
     def engage(self):
         if not self.action:
             raise exception.NoActionInProgress
-        atomic = self.action[0].atomic
+        continuable = self.action[0].continuable
 
         def _save_state():
-            if not atomic:
+            if continuable:
                 self.save_state()
         self.action_manager.ensure_leaf_action(self.action,
                                                on_change_callback=_save_state)
@@ -198,7 +197,7 @@ def _save_state():
                 select_next = not ex.kwargs.get('rerun', False)
                 abort = True
             except exception.ActionFinished as ex:
-                self.clear_state(state_file=not atomic)
+                self.clear_state(state_file=continuable)
                 print(ex)
                 return
             except exception.ActionGoto as ex:
@@ -212,11 +211,11 @@ def _save_state():
             if select_next:
                 self.action = self.action_manager.next_action(self.action)
             if not self.action:
-                if not atomic:
+                if continuable:
                     print("Action finished.")
-                self.clear_state(state_file=not atomic)
+                self.clear_state(state_file=continuable)
                 return
-            if not atomic:
+            if continuable:
                 self.save_state()
             if abort:
                 return