modulesync 2.1.0 → 2.3.0

data/features/update.feature

@@ -14,9 +14,8 @@ Feature: update
       """
       <%= @configs['name'] %>
       """
-    When I run `msync update --noop`
-    Then the exit status should be 0
-    And the output should match:
+    When I successfully run `msync update --noop`
+    Then the output should match:
       """
       Files added:
       test
@@ -37,9 +36,8 @@ Feature: update
       """
       <%= @configs['name'] %>
       """
-    When I run `msync update -s -m "Add test"`
-    Then the exit status should be 0
-    And the puppet module "puppet-test" from "fakenamespace" should have no commits made by "Aruba"
+    When I successfully run `msync update -s -m "Add test"`
+    Then the puppet module "puppet-test" from "fakenamespace" should have no commits made by "Aruba"
 
   Scenario: Adding a new file to repo without write access
     Given a basic setup with a puppet module "puppet-test" from "fakenamespace"
@@ -72,9 +70,8 @@ Feature: update
       """
       <%= @configs['name'] %>
       """
-    When I run `msync update --noop`
-    Then the exit status should be 0
-    And the output should match:
+    When I successfully run `msync update --noop`
+    Then the output should match:
       """
       Warning: using './moduleroot/test' as template without '.erb' suffix
       """
@@ -99,9 +96,8 @@ Feature: update
       """
       <%= @configs['name'] %>
       """
-    When I run `msync update --noop`
-    Then the exit status should be 0
-    And the output should match:
+    When I successfully run `msync update --noop`
+    Then the output should match:
       """
       Files added:
       test
@@ -125,9 +121,8 @@ Feature: update
       """
       <%= @configs['name'] %>
       """
-    When I run `msync update --noop`
-    Then the exit status should be 0
-    And the output should match:
+    When I successfully run `msync update --noop`
+    Then the output should match:
       """
       Files added:
       test
@@ -151,9 +146,8 @@ Feature: update
       """
       <%= @configs['name'] %>
       """
-    When I run `msync update --noop`
-    Then the exit status should be 0
-    And the output should match:
+    When I successfully run `msync update --noop`
+    Then the output should match:
       """
       Files added:
       test
@@ -195,9 +189,8 @@ Feature: update
         <%= c['name'] %>
       <% end %>
       """
-    When I run `msync update --noop -s`
-    Then the exit status should be 0
-    And the puppet module "puppet-test" from "fakenamespace" should have no commits made by "Aruba"
+    When I successfully run `msync update --noop -s`
+    Then the puppet module "puppet-test" from "fakenamespace" should have no commits made by "Aruba"
 
   Scenario: Using skip_broken and fail_on_warnings options with invalid files
     Given a basic setup with a puppet module "puppet-test" from "fakenamespace"
@@ -235,9 +228,8 @@ Feature: update
       """
       source '<%= @configs['gem_source'] %>'
       """
-    When I run `msync update --noop`
-    Then the exit status should be 0
-    And the output should match:
+    When I successfully run `msync update --noop`
+    Then the output should match:
       """
       Files changed:
       +diff --git a/Gemfile b/Gemfile
@@ -265,9 +257,8 @@ Feature: update
       """
       source '<%= @configs['gem_source'] %>'
       """
-    When I run `msync update -m "Update Gemfile" -r test`
-    Then the exit status should be 0
-    And the puppet module "puppet-test" from "fakenamespace" should have only 1 commit made by "Aruba"
+    When I successfully run `msync update -m "Update Gemfile" -r test`
+    Then the puppet module "puppet-test" from "fakenamespace" should have only 1 commit made by "Aruba"
     And the puppet module "puppet-test" from "fakenamespace" should have 1 commit made by "Aruba" in branch "test"
     And the puppet module "puppet-test" from "fakenamespace" should have a branch "test" with a file named "Gemfile" which contains:
       """
@@ -292,7 +283,7 @@ Feature: update
       """
       source '<%= @configs['gem_source'] %>'
       """
-    When I run `msync update --noop`
+    When I successfully run `msync update --noop`
     Then the output should not match:
       """
       Files changed:
@@ -302,7 +293,6 @@ Feature: update
       """
       Not managing 'Gemfile' in 'puppet-test'
       """
-    And the exit status should be 0
     And the file named "modules/fakenamespace/puppet-test/Gemfile" should contain:
       """
       source 'https://rubygems.org'
@@ -326,14 +316,13 @@ Feature: update
       """
       source 'https://rubygems.org'
       """
-    When I run `msync update --noop`
+    When I successfully run `msync update --noop`
     Then the output should match:
       """
       Files changed:
       diff --git a/Gemfile b/Gemfile
       deleted file mode 100644
       """
-    And the exit status should be 0
     And the puppet module "puppet-test" from "fakenamespace" should have no commits made by "Aruba"
 
   Scenario: Setting a non-existent file to deleted
@@ -345,12 +334,12 @@ Feature: update
         delete: true
       """
     And a directory named "moduleroot"
-    When I run `msync update -m 'deletes a file that doesnt exist!' -f puppet-test`
-    And the exit status should be 0
-    And the puppet module "puppet-test" from "fakenamespace" should have no commits made by "Aruba"
+    When I successfully run `msync update -m 'deletes a file that doesnt exist!' -f puppet-test`
+    Then the puppet module "puppet-test" from "fakenamespace" should have no commits made by "Aruba"
 
   Scenario: Setting a directory to unmanaged
     Given a basic setup with a puppet module "puppet-apache" from "puppetlabs"
+    And I successfully run `msync clone`
     And a file named "config_defaults.yml" with:
       """
       ---
@@ -367,17 +356,15 @@ Feature: update
       """
       This is a fake spec_helper!
       """
-    When I run `msync update --offline`
+    When I successfully run `msync update --offline`
     Then the output should contain:
       """
       Not managing 'spec/spec_helper.rb' in 'puppet-apache'
       """
-    And the exit status should be 0
     And the file named "modules/puppetlabs/puppet-apache/spec/spec_helper.rb" should contain:
       """
       This is a fake spec_helper!
       """
-    And the exit status should be 0
     And the puppet module "puppet-apache" from "puppetlabs" should have no commits made by "Aruba"
 
   Scenario: Adding a new file in a new subdirectory
@@ -395,9 +382,8 @@ Feature: update
         require '<%= required %>'
       <% end %>
       """
-    When I run `msync update --noop`
-    Then the exit status should be 0
-    And the output should match:
+    When I successfully run `msync update --noop`
+    Then the output should match:
       """
       Files added:
       spec/spec_helper.rb
@@ -410,6 +396,7 @@ Feature: update
 
   Scenario: Updating offline
     Given a basic setup with a puppet module "puppet-test" from "fakenamespace"
+    And I successfully run `msync clone`
     And a file named "config_defaults.yml" with:
       """
       ---
@@ -423,17 +410,15 @@ Feature: update
         require '<%= required %>'
       <% end %>
       """
-    When I run `msync update --offline`
-    Then the exit status should be 0
-    And the output should not match /Files (changed|added|deleted):/
+    When I successfully run `msync update --offline`
+    Then the output should not match /Files (changed|added|deleted):/
     And the puppet module "puppet-test" from "fakenamespace" should have no commits made by "Aruba"
 
   Scenario: Pulling a module that already exists in the modules directory
     Given a basic setup with a puppet module "puppet-test" from "fakenamespace"
     And a directory named "moduleroot"
-    When I run `msync update --message "First update run"`
-    Then the exit status should be 0
-    And the puppet module "puppet-test" from "fakenamespace" should have no commits made by "Aruba"
+    When I successfully run `msync update --message "First update run"`
+    Then the puppet module "puppet-test" from "fakenamespace" should have no commits made by "Aruba"
     Given a file named "config_defaults.yml" with:
       """
       ---
@@ -447,9 +432,8 @@ Feature: update
         require '<%= required %>'
       <% end %>
       """
-    When I run `msync update --noop`
-    Then the exit status should be 0
-    And the output should match:
+    When I successfully run `msync update --noop`
+    Then the output should match:
       """
       Files added:
       spec/spec_helper.rb
@@ -459,9 +443,8 @@ Feature: update
   Scenario: When running update without changes
     Given a basic setup with a puppet module "puppet-test" from "fakenamespace"
     And a directory named "moduleroot"
-    When I run `msync update --message "Running without changes"`
-    Then the exit status should be 0
-    And the stdout should contain "There were no changes in 'modules/fakenamespace/puppet-test'. Not committing."
+    When I successfully run `msync update --verbose --message "Running without changes"`
+    Then the stdout should contain "There were no changes in 'modules/fakenamespace/puppet-test'. Not committing."
     And the puppet module "puppet-test" from "fakenamespace" should have no commits made by "Aruba"
 
   Scenario: When specifying configurations in managed_modules.yml
@@ -483,9 +466,8 @@ Feature: update
       """
       <%= @configs['name'] %>
       """
-    When I run `msync update --noop`
-    Then the exit status should be 0
-    And the output should match:
+    When I successfully run `msync update --noop`
+    Then the output should match:
       """
       Files added:
       test
@@ -521,9 +503,8 @@ Feature: update
       """
       <%= @configs['name'] %>
       """
-    When I run `msync update --noop -f puppet-test`
-    Then the exit status should be 0
-    And the output should match:
+    When I successfully run `msync update --noop -f puppet-test`
+    Then the output should match:
       """
       Files added:
       test
@@ -560,9 +541,8 @@ Feature: update
       """
       <%= @configs['name'] %>
       """
-    When I run `msync update --noop -x puppet-blacksmith`
-    Then the exit status should be 0
-    And the output should match:
+    When I successfully run `msync update --noop -x puppet-blacksmith`
+    Then the output should match:
       """
       Files added:
       test
@@ -604,9 +584,8 @@ Feature: update
       spec/spec_helper.rb:
         unmanaged: true
       """
-    When I run `msync update --noop`
-    Then the exit status should be 0
-    And the output should match:
+    When I successfully run `msync update --noop`
+    Then the output should match:
       """
       Not managing 'spec/spec_helper.rb' in 'puppet-test'
       """
@@ -645,9 +624,8 @@ Feature: update
       """
       <%= @configs['name'] %>
       """
-    When I run `msync update --noop`
-    Then the exit status should be 0
-    And the output should match:
+    When I successfully run `msync update --noop`
+    Then the output should match:
       """
       Files added:
       test
@@ -674,9 +652,8 @@ Feature: update
       """
       Hello world!
       """
-    When I run `msync update --noop`
-    Then the exit status should be 0
-    And the output should match:
+    When I successfully run `msync update --noop`
+    Then the output should match:
       """
       Files changed:
       +diff --git a/README.md b/README.md
@@ -701,40 +678,16 @@ Feature: update
       """
       source '<%= @configs['gem_source'] %>'
       """
-    When I run `msync update -m "Update Gemfile" -r test`
-    Then the exit status should be 0
-    And the puppet module "puppet-test" from "fakenamespace" should have only 1 commit made by "Aruba"
+    When I successfully run `msync update -m "Update Gemfile" -r test`
+    Then the puppet module "puppet-test" from "fakenamespace" should have only 1 commit made by "Aruba"
     And the puppet module "puppet-test" from "fakenamespace" should have 1 commit made by "Aruba" in branch "test"
     Given I remove the directory "modules"
-    When I run `msync update -m "Update Gemfile" -r test`
-    Then the exit status should be 0
+    When I successfully run `msync update -m "Update Gemfile" -r test`
     Then the output should not contain "error"
     Then the output should not contain "rejected"
     And the puppet module "puppet-test" from "fakenamespace" should have only 1 commit made by "Aruba"
     And the puppet module "puppet-test" from "fakenamespace" should have 1 commit made by "Aruba" in branch "test"
 
-  Scenario: Creating a GitHub PR with an update
-    Given a basic setup with a puppet module "puppet-test" from "fakenamespace"
-    And a directory named "moduleroot"
-    And I set the environment variables to:
-      | variable     | value  |
-      | GITHUB_TOKEN | foobar |
-    When I run `msync update --noop --branch managed_update --pr`
-    Then the output should contain "Would submit PR "
-    And the exit status should be 0
-    And the puppet module "puppet-test" from "fakenamespace" should have no commits made by "Aruba"
-
-  Scenario: Creating a GitLab MR with an update
-    Given a basic setup with a puppet module "puppet-test" from "fakenamespace"
-    And a directory named "moduleroot"
-    And I set the environment variables to:
-      | variable     | value  |
-      | GITLAB_TOKEN | foobar |
-    When I run `msync update --noop --branch managed_update --pr`
-    Then the output should contain "Would submit MR "
-    And the exit status should be 0
-    And the puppet module "puppet-test" from "fakenamespace" should have no commits made by "Aruba"
-
   Scenario: Repository with a default branch other than master
     Given a basic setup with a puppet module "puppet-test" from "fakenamespace"
     And the puppet module "puppet-test" from "fakenamespace" has the default branch named "develop"
@@ -749,9 +702,8 @@ Feature: update
       """
       source '<%= @configs['gem_source'] %>'
       """
-    When I run `msync update -m "Update Gemfile"`
-    Then the exit status should be 0
-    And the output should contain "Using repository's default branch: develop"
+    When I successfully run `msync update --verbose -m "Update Gemfile"`
+    Then the output should contain "Using repository's default branch: develop"
     And the puppet module "puppet-test" from "fakenamespace" should have only 1 commit made by "Aruba"
     And the puppet module "puppet-test" from "fakenamespace" should have 1 commit made by "Aruba" in branch "develop"
 
@@ -768,12 +720,31 @@ Feature: update
       target: <%= @metadata[:target_file] %>
       workdir: <%= @metadata[:workdir] %>
       """
-    When I run `msync update --noop`
-    Then the exit status should be 0
-    And the file named "modules/fakenamespace/puppet-test/test" should contain:
+    When I successfully run `msync update --noop`
+    Then the file named "modules/fakenamespace/puppet-test/test" should contain:
       """
       module: puppet-test
       target: modules/fakenamespace/puppet-test/test
       workdir: modules/fakenamespace/puppet-test
       """
     And the puppet module "puppet-test" from "fakenamespace" should have no commits made by "Aruba"
+
+  # This reproduces the issue: https://github.com/voxpupuli/modulesync/issues/81
+  Scenario: Resync repositories after upstream branch deletion
+    Given a basic setup with a puppet module "puppet-test" from "fakenamespace"
+    And a file named "config_defaults.yml" with:
+      """
+      ---
+      test:
+        name: aruba
+      """
+    And a directory named "moduleroot"
+    And a file named "moduleroot/test.erb" with:
+      """
+      <%= @configs['name'] %>
+      """
+    When I successfully run `msync update -m "No changes!" --branch delete-me`
+    Then the puppet module "puppet-test" from "fakenamespace" should have 1 commit made by "Aruba" in branch "delete-me"
+    When the branch "delete-me" of the puppet module "puppet-test" from "fakenamespace" is deleted
+    And I successfully run `msync update -m "No changes!" --branch delete-me`
+    Then the puppet module "puppet-test" from "fakenamespace" should have no commits made by "Aruba"

data/lib/modulesync/cli/thor.rb

@@ -8,7 +8,19 @@ module ModuleSync
     # This class extends ::Thor class to
     # - exit with status code sets to `1` on Thor failure (e.g. missing required option)
     # - exit with status code sets to `1` when user calls `msync` (or a subcommand) without required arguments
+    # - show subcommands help using `msync subcommand --help`
     class Thor < ::Thor
+      def self.start(*args)
+        if (Thor::HELP_MAPPINGS & ARGV).any? && subcommands.none? { |command| command.start_with?(ARGV[0]) }
+          Thor::HELP_MAPPINGS.each do |cmd|
+            if (match = ARGV.delete(cmd))
+              ARGV.unshift match
+            end
+          end
+        end
+        super
+      end
+
       desc '_invalid_command_call', 'Invalid command', hide: true
       def _invalid_command_call
         self.class.new.help

data/lib/modulesync/cli.rb

@@ -7,31 +7,34 @@ require 'modulesync/util'
 
 module ModuleSync
   module CLI
+    def self.prepare_options(cli_options, **more_options)
+      options = CLI.defaults
+      options.merge! Util.symbolize_keys(cli_options)
+      options.merge! more_options
+
+      Util.symbolize_keys options
+    end
+
     def self.defaults
       @defaults ||= Util.symbolize_keys(Util.parse_config(Constants::MODULESYNC_CONF_FILE))
     end
 
     class Hook < Thor
-      class_option :project_root,
-                   :aliases => '-c',
-                   :desc => 'Path used by git to clone modules into. Defaults to "modules"',
-                   :default => CLI.defaults[:project_root] || 'modules'
-      class_option :hook_args,
-                   :aliases => '-a',
-                   :desc => 'Arguments to pass to msync in the git hook'
-
+      option :hook_args,
+             :aliases => '-a',
+             :desc => 'Arguments to pass to msync in the git hook'
+      option :branch,
+             :aliases => '-b',
+             :desc => 'Branch name to pass to msync in the git hook',
+             :default => CLI.defaults[:branch]
       desc 'activate', 'Activate the git hook.'
       def activate
-        config = { :command => 'hook' }.merge(options)
-        config[:hook] = 'activate'
-        ModuleSync.hook(config)
+        ModuleSync.hook CLI.prepare_options(options, hook: 'activate')
       end
 
       desc 'deactivate', 'Deactivate the git hook.'
       def deactivate
-        config = { :command => 'hook' }.merge(options)
-        config[:hook] = 'deactivate'
-        ModuleSync.hook(config)
+        ModuleSync.hook CLI.prepare_options(options, hook: 'deactivate')
       end
     end
 
@@ -39,7 +42,7 @@ module ModuleSync
       class_option :project_root,
                    :aliases => '-c',
                    :desc => 'Path used by git to clone modules into.',
-                   :default => CLI.defaults[:project_root] || 'modules'
+                   :default => CLI.defaults[:project_root]
       class_option :git_base,
                    :desc => 'Specify the base part of a git URL to pull from',
                    :default => CLI.defaults[:git_base] || 'git@github.com:'
@@ -53,11 +56,11 @@ module ModuleSync
       class_option :negative_filter,
                    :aliases => '-x',
                    :desc => 'A regular expression to skip repositories.'
-      class_option :branch,
-                   :aliases => '-b',
-                   :desc => 'Branch name to make the changes in.' \
-                              ' Defaults to the default branch of the upstream repository, but falls back to "master".',
-                   :default => CLI.defaults[:branch]
+      class_option :verbose,
+                   :aliases => '-v',
+                   :desc => 'Verbose mode',
+                   :type => :boolean,
+                   :default => false
 
       desc 'update', 'Update the modules in managed_modules.yml'
       option :message,
@@ -67,7 +70,7 @@ module ModuleSync
       option :configs,
              :aliases => '-c',
              :desc => 'The local directory or remote repository to define the list of managed modules,' \
-                        ' the file templates, and the default values for template variables.'
+                      ' the file templates, and the default values for template variables.'
       option :managed_modules_conf,
              :desc => 'The file name to define the list of managed modules'
       option :remote_branch,
@@ -104,7 +107,7 @@ module ModuleSync
              :default => CLI.defaults[:pr_labels] || []
       option :pr_target_branch,
              :desc => 'Target branch for the pull/merge request',
-             :default => CLI.defaults[:pr_target_branch] || 'master'
+             :default => CLI.defaults[:pr_target_branch]
       option :offline,
              :type => :boolean,
              :desc => 'Do not run any Git commands. Allows the user to manage Git outside of ModuleSync.',
@@ -130,17 +133,108 @@ module ModuleSync
              :type => :boolean,
              :aliases => '-F',
              :desc => 'Produce a failure exit code when there are warnings' \
-                        ' (only has effect when --skip_broken is enabled)',
+                      ' (only has effect when --skip_broken is enabled)',
              :default => false
-
+      option :branch,
+             :aliases => '-b',
+             :desc => 'Branch name to make the changes in.' \
+                      ' Defaults to the default branch of the upstream repository, but falls back to "master".',
+             :default => CLI.defaults[:branch]
       def update
-        config = { :command => 'update' }.merge(options)
-        config = Util.symbolize_keys(config)
+        config = CLI.prepare_options(options)
         raise Thor::Error, 'No value provided for required option "--message"' unless config[:noop] \
                                                                                       || config[:message] \
                                                                                       || config[:offline]
-        config[:git_opts] = { 'amend' => config[:amend], 'force' => config[:force] }
-        ModuleSync.update(config)
+
+        ModuleSync.update config
+      end
+
+      desc 'execute [OPTIONS] -- COMMAND..', 'Execute the command in each managed modules'
+      long_desc <<~DESC
+        Execute the command in each managed modules.
+
+        COMMAND can be an absolute or a relative path.
+
+        To ease running local commands, a relative path is expanded with the current user directory but only if the target file exists.
+
+        Example: `msync exec custom-scripts/true` will run "$PWD/custom-scripts/true" in each repository.
+
+        As side effect, you can shadow system binary if a local file is present:
+        \x5  `msync exec true` will run "$PWD/true", not `/bin/true` if "$PWD/true" exists.
+      DESC
+
+      option :configs,
+             :aliases => '-c',
+             :desc => 'The local directory or remote repository to define the list of managed modules,' \
+                      ' the file templates, and the default values for template variables.'
+      option :managed_modules_conf,
+             :desc => 'The file name to define the list of managed modules'
+      option :branch,
+             :aliases => '-b',
+             :desc => 'Branch name to make the changes in.',
+             :default => CLI.defaults[:branch]
+      option :fail_fast,
+             :type => :boolean,
+             :desc => 'Abort the run after a command execution failure',
+             :default => CLI.defaults[:fail_fast].nil? ? true : CLI.defaults[:fail_fast]
+      def execute(*command_args)
+        raise Thor::Error, 'COMMAND is a required argument' if command_args.empty?
+
+        ModuleSync.execute CLI.prepare_options(options, command_args: command_args)
+      end
+
+      desc 'reset', 'Reset local repositories to a well-known state'
+      long_desc <<~DESC
+        Reset local repository to a well-known state:
+        \x5  * Switch local repositories to specified branch
+        \x5  * Fetch and prune repositories unless running with `--offline` option
+        \x5  * Hard-reset any changes to specified source branch, technically any git refs, e.g. `main`, `origin/wip`
+        \x5  * Clean all extra local files
+
+        Note: If a repository is not already cloned, it will operate the following to reach to well-known state:
+        \x5  * Clone the repository
+        \x5  * Switch to specified branch
+      DESC
+      option :configs,
+             :aliases => '-c',
+             :desc => 'The local directory or remote repository to define the list of managed modules,' \
+                      ' the file templates, and the default values for template variables.'
+      option :managed_modules_conf,
+             :desc => 'The file name to define the list of managed modules'
+      option :branch,
+             :aliases => '-b',
+             :desc => 'Branch name to make the changes in.',
+             :default => CLI.defaults[:branch]
+      option :offline,
+             :type => :boolean,
+             :desc => 'Only proceed local operations',
+             :default => false
+      option :source_branch,
+             :desc => 'Branch to reset from (e.g. origin/wip)'
+      def reset
+        ModuleSync.reset CLI.prepare_options(options)
+      end
+
+      desc 'push', 'Push all available commits from branch to remote'
+      option :configs,
+             :aliases => '-c',
+             :desc => 'The local directory or remote repository to define the list of managed modules,' \
+                      ' the file templates, and the default values for template variables.'
+      option :managed_modules_conf,
+             :desc => 'The file name to define the list of managed modules'
+      option :branch,
+             :aliases => '-b',
+             :desc => 'Branch name to push',
+             :default => CLI.defaults[:branch]
+      option :remote_branch,
+             :desc => 'Remote branch to push to (e.g. maintenance)'
+      def push
+        ModuleSync.push CLI.prepare_options(options)
+      end
+
+      desc 'clone', 'Clone repositories that need to'
+      def clone
+        ModuleSync.clone CLI.prepare_options(options)
       end
 
       desc 'hook', 'Activate or deactivate a git hook.'