Add new commands: execute and push

.config/cucumber.yml

@@ -0,0 +1 @@
+default: --publish-quiet

.rubocop.yml

@@ -25,6 +25,8 @@ Layout/IndentHeredoc:
 # sane line length
 Metrics/LineLength:
   Max: 120
+  Exclude:
+    - 'features/**/*'
 
 Style/FrozenStringLiteralComment:
   Enabled: false

README.md

@@ -10,6 +10,7 @@ Table of Contents
 4. [Installing](#installing)
 5. [Workflow](#workflow)
 6. [The Templates](#the-templates)
+7. [Additional features](#additional-features)
 
 Usage TLDR
 ----------
@@ -436,3 +437,38 @@ The Templates
 
 See [Puppet's modulesync\_configs](https://github.com/puppetlabs/modulesync_configs) and [Vox Pupuli's modulesync\_config](https://github.com/voxpupuli/modulesync_config)
 repositories for different templates currently in use.
+
+Additional features
+-------------------
+
+## Execute a custom script on each module
+
+During puppet modules maintenance, you may want to run a custom script to modify, add or deleted files then commit modifications.
+
+As example, if you want to generate REFERENCES.md, CHANGELOG.md or update your module to be PDK compliant, this command could be useful.
+
+```shell
+msync exec /path/to/script --branch my-new-feature
+```
+
+**Important**: Please note that it is up to your script to modify correctly the repository (e.g. `git mv old-path new-path`, `git add my-file`) and performs the commits (ie. `git commit -m'Set a smart commit message here'`).
+
+Like `update` command, you can push and submit a PR/MR using the same options:
+
+```shell
+msync exec /path/to/script --branch my-new-feature --push --pr --pr-title "Add a new super feature"
+```
+
+## Push manually a branch for each module
+
+After a regular `msync update` without push, you may want to add some commits manually then push.
+
+```shell
+msync push --branch my-specific-branch
+```
+
+Like `update` command, you can submit a PR/MR using the same options:
+
+```shell
+msync push --branch my-specific-feature-branch --pr --pr-title "Add a new super feature"
+```

features/cli.feature

@@ -18,18 +18,11 @@ Feature: CLI
     And the output should match /Commands:/
 
   Scenario: When overriding a setting from the config file on the command line
-    Given a file named "managed_modules.yml" with:
-      """
-      ---
-        - puppet-test
-      """
-    And a file named "modulesync.yml" with:
-      """
-      ---
-        namespace: maestrodev
-        git_base: 'git@github.com:'
-      """
+    Given a basic setup with a puppet module "puppet-test" from "fakenamespace"
     And a directory named "moduleroot"
-    When I run `msync update --noop --git-base https://github.com/`
+    When I run `msync update --noop --namespace fakenamespace`
     Then the exit status should be 0
-    And the output should not match /git@github.com:/
+    And the stdout should contain:
+      """
+      Syncing 'fakenamespace/puppet-test'
+      """

features/execute.feature

@@ -0,0 +1,25 @@
+Feature: execute
+  Use ModuleSync to execute a custom script on a specified branch for each repos and optionaly push and submit a PR/MR
+
+  Scenario: Running command without required 'branch' option
+    When I run `msync exec`
+    Then the output should match /^No value provided for required options '--branch'$/
+
+  Scenario: Cloning modules before running command when modules/ dir is empty
+    Given a basic setup with a puppet module "puppet-test" from "awesome"
+    Then the file "modules/awesome/puppet-test/metadata.json" should not exist
+    When I run `msync exec -b master /bin/true`
+    Then the exit status should be 0
+    And the file "modules/awesome/puppet-test/metadata.json" should exist
+
+  @no-clobber
+  Scenario: Hard-reset on specified branch before running command when modules have already been cloned
+    Given the file "modules/awesome/puppet-test/metadata.json" should exist
+    And the file "modules/awesome/puppet-test/hello" should not exist
+    And the puppet module "puppet-test" from "awesome" have a branch "execute"
+    And the puppet module "puppet-test" from "awesome" have a file named "hello" on branch "execute" with:
+      """
+      Hello
+      """
+    When I run `msync exec -b master --reset-hard origin/execute /bin/true`
+    And the file "modules/awesome/puppet-test/hello" should exist

features/hook.feature

@@ -5,8 +5,7 @@ Feature: hook
     Given a directory named ".git/hooks"
     When I run `msync hook activate`
     Then the exit status should be 0
-    Given I run `cat .git/hooks/pre-push`
-    Then the output should contain "bash"
+    And the file named ".git/hooks/pre-push" should contain "bash"
 
   Scenario: Deactivating a hook
     Given a file named ".git/hooks/pre-push" with:
@@ -21,8 +20,7 @@ Feature: hook
     Given a directory named ".git/hooks"
     When I run `msync hook activate -a '--foo bar --baz quux' -b master`
     Then the exit status should be 0
-    Given I run `cat .git/hooks/pre-push`
-    Then the output should match:
+    And the file named ".git/hooks/pre-push" should contain:
       """
-      "\$message" -n puppetlabs -b master --foo bar --baz quux
+      "$message" -n puppetlabs -b master --foo bar --baz quux
       """

features/push.feature

@@ -0,0 +1,15 @@
+Feature: push
+  Use ModuleSync to push a specified branch from each repos and optionaly submit a PR/MR
+
+  Scenario: When 'branch' option is missing
+    When I run `msync push`
+    Then the output should match /^No value provided for required options '--branch'$/
+
+  Scenario: Report the need to clone repositories if puppet module have not been fetch before
+    Given a basic setup with a puppet module "puppet-test" from "awesome"
+    When I run `msync push --branch hello`
+    Then the exit status should be 1
+    And the stderr should contain:
+      """
+      Repository must be locally available before trying to push
+      """

features/step_definitions/git_steps.rb

@@ -1,48 +1,85 @@
-Given 'a mocked git configuration' do
-  steps %(
-    Given a mocked home directory
-    And I run `git config --global user.name Test`
-    And I run `git config --global user.email test@example.com`
-  )
-end
+require_relative '../../spec/helpers/faker/puppet_module_remote_repo'
 
-Given 'a remote module repository' do
+Given 'a basic setup with a puppet module {string} from {string}' do |name, namespace|
   steps %(
-    Given a directory named "sources"
-    And I run `git clone https://github.com/maestrodev/puppet-test sources/puppet-test`
+    Given a mocked git configuration
+    And a puppet module "#{name}" from "#{namespace}"
     And a file named "managed_modules.yml" with:
       """
       ---
-        - puppet-test
+        - #{name}
       """
+    And a file named "modulesync.yml" with:
+      """
+      ---
+      namespace: #{namespace}
+      """
+    And a git_base option appended to "modulesync.yml" for local tests
   )
-  write_file('modulesync.yml', <<~CONFIG)
-    ---
-    namespace: sources
-    git_base: file://#{expand_path('.')}/
-    CONFIG
 end
 
-Given Regexp.new(/a remote module repository with "(.+?)" as the default branch/) do |branch|
+Given 'a mocked git configuration' do
   steps %(
-    Given a directory named "sources"
-    And I run `git clone --mirror https://github.com/maestrodev/puppet-test sources/puppet-test`
-    And a file named "managed_modules.yml" with:
-      """
-      ---
-        - puppet-test
-      """
+    Given a mocked home directory
+    And I run `git config --global user.name Aruba`
+    And I run `git config --global user.email aruba@example.com`
   )
-  write_file('modulesync.yml', <<~CONFIG)
-    ---
-    namespace: sources
-    git_base: file://#{expand_path('.')}/
-    CONFIG
-
-  cd('sources/puppet-test') do
-    steps %(
-      And I run `git branch -M master #{branch}`
-      And I run `git symbolic-ref HEAD refs/heads/#{branch}`
-    )
-  end
+end
+
+Given 'a puppet module {string} from {string}' do |name, namespace|
+  pmrr = Faker::PuppetModuleRemoteRepo.new(name, namespace)
+  pmrr.populate
+end
+
+Given 'a git_base option appended to "modulesync.yml" for local tests' do
+  File.write "#{Aruba.config.working_directory}/modulesync.yml", "\ngit_base: #{Faker::PuppetModuleRemoteRepo.git_base}", mode: 'a'
+end
+
+Given 'the puppet module {string} from {string} is read-only' do |name, namespace|
+  pmrr = Faker::PuppetModuleRemoteRepo.new(name, namespace)
+  pmrr.read_only = true
+end
+
+Then 'the puppet module {string} from {string} have no commit between {string} and {string}' do |name, namespace, commit1, commit2|
+  pmrr = Faker::PuppetModuleRemoteRepo.new(name, namespace)
+  expect(pmrr.commit_count_between(commit1, commit2)).to eq 0
+end
+
+Then 'the puppet module {string} from {string} have( only) {int} commit(s) made by {string}' do |name, namespace, commit_count, author|
+  pmrr = Faker::PuppetModuleRemoteRepo.new(name, namespace)
+  expect(pmrr.commit_count_by(author)).to eq commit_count
+end
+
+Then 'the puppet module {string} from {string} have( only) {int} commit(s) made by {string} in branch {string}' do |name, namespace, commit_count, author, branch|
+  pmrr = Faker::PuppetModuleRemoteRepo.new(name, namespace)
+  expect(pmrr.commit_count_by(author, branch)).to eq commit_count
+end
+
+Then 'the puppet module {string} from {string} have no commit made by {string}' do |name, namespace, author|
+  step "the puppet module \"#{name}\" from \"#{namespace}\" have 0 commit made by \"#{author}\""
+end
+
+Given 'the puppet module {string} from {string} have a file named {string} with:' do |name, namespace, filename, content|
+  pmrr = Faker::PuppetModuleRemoteRepo.new(name, namespace)
+  pmrr.add_file(filename, content)
+end
+
+Given 'the puppet module {string} from {string} have a file named {string} on branch {string} with:' do |name, namespace, filename, branch, content|
+  pmrr = Faker::PuppetModuleRemoteRepo.new(name, namespace)
+  pmrr.add_file(filename, content, branch)
+end
+
+Then 'the puppet module {string} from {string} should have a branch {string} with a file named {string} which contains:' do |name, namespace, branch, filename, content|
+  pmrr = Faker::PuppetModuleRemoteRepo.new(name, namespace)
+  expect(pmrr.read_file(filename, branch)).to include(content)
+end
+
+Given 'the puppet module {string} from {string} have the default branch named {string}' do |name, namespace, default_branch|
+  pmrr = Faker::PuppetModuleRemoteRepo.new(name, namespace)
+  pmrr.default_branch = default_branch
+end
+
+Given 'the puppet module {string} from {string} have a branch {string}' do |name, namespace, branch|
+  pmrr = Faker::PuppetModuleRemoteRepo.new(name, namespace)
+  pmrr.create_branch(branch)
 end

features/support/env.rb

@@ -1,5 +1,9 @@
 require 'aruba/cucumber'
 
+require_relative '../../spec/helpers/faker'
+
+Faker.working_directory = File.expand_path("#{Aruba.config.working_directory}/faker")
+
 Before do
   @aruba_timeout_seconds = 5
 end