modulesync 2.1.0 → 2.3.0

data/features/execute.feature

@@ -0,0 +1,51 @@
+Feature: execute
+  Use ModuleSync to execute a custom script on each repositories
+
+  Scenario: Cloning sourcecodes 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 successfully run `msync exec --verbose -- /bin/true`
+    Then the stdout should contain "Cloning from 'file://"
+    And the file "modules/awesome/puppet-test/metadata.json" should exist
+
+  @no-clobber
+  Scenario: No clones before running command when sourcecode have already been cloned
+    Then the file "modules/awesome/puppet-test/metadata.json" should exist
+    When I successfully run `msync exec --verbose /bin/true`
+    Then the stdout should not contain "Cloning from 'file://"
+
+  @no-clobber
+  Scenario: When command run fails, fail fast if option defined
+    When I run `msync exec --verbose --fail-fast -- /bin/false`
+    Then the exit status should be 1
+    And the stderr should contain:
+    """
+    Command execution failed
+    """
+
+  @no-clobber
+  Scenario: When command run fails, run all and summarize errors if option fail-fast is not set
+    When I run `msync exec --verbose --no-fail-fast -- /bin/false`
+    Then the exit status should be 1
+    And the stderr should contain:
+    """
+    Error(s) during `execute` command:
+      *
+    """
+
+  Scenario: Show fail-fast default value in help
+    When I successfully run `msync help exec`
+    Then the stdout should contain:
+    """
+          [--fail-fast], [--no-fail-fast]                # Abort the run after a command execution failure
+                                                         # Default: true
+    """
+
+  Scenario: Override fail-fast default value using config file
+    Given the global option "fail_fast" sets to "false"
+    When I successfully run `msync help exec`
+    Then the stdout should contain:
+    """
+          [--fail-fast], [--no-fail-fast]                # Abort the run after a command execution failure
+    """
+    # NOTE: It seems there is a Thor bug here: default value is missing in help when sets to 'false'

data/features/hook.feature

@@ -3,24 +3,21 @@ Feature: hook
 
   Scenario: Activating a hook
     Given a directory named ".git/hooks"
-    When I run `msync hook activate`
-    Then the exit status should be 0
-    And the file named ".git/hooks/pre-push" should contain "bash"
+    When I successfully run `msync hook activate`
+    Then the file named ".git/hooks/pre-push" should contain "bash"
 
   Scenario: Deactivating a hook
     Given a file named ".git/hooks/pre-push" with:
       """
       git hook
       """
-    When I run `msync hook deactivate`
-    Then the exit status should be 0
+    When I successfully run `msync hook deactivate`
     Then the file ".git/hooks/pre-push" should not exist
 
   Scenario: Activating a hook with arguments
     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
-    And the file named ".git/hooks/pre-push" should contain:
+    When I successfully run `msync hook activate -a '--foo bar --baz quux' -b master`
+    Then the file named ".git/hooks/pre-push" should contain:
       """
       "$message" -n puppetlabs -b master --foo bar --baz quux
       """

data/features/push.feature

@@ -0,0 +1,46 @@
+Feature: push
+  Push commits to remote
+
+  Scenario: Push available commits to remote
+    Given a mocked git configuration
+    And a puppet module "puppet-test" from "awesome"
+    And a file named "managed_modules.yml" with:
+    """
+    ---
+    puppet-test:
+      namespace: awesome
+    """
+    And a file named "modulesync.yml" with:
+    """
+    ---
+    branch: modulesync
+    """
+    And a git_base option appended to "modulesync.yml" for local tests
+    And I successfully run `msync reset`
+    And I cd to "modules/awesome/puppet-test"
+    And I run `touch hello`
+    And I run `git add hello`
+    And I run `git commit -m'Hello!'`
+    And I cd to "~"
+    Then the puppet module "puppet-test" from "awesome" should have no commits made by "Aruba"
+    When I successfully run `msync push --verbose`
+    Then the puppet module "puppet-test" from "awesome" should have 1 commit made by "Aruba" in branch "modulesync"
+
+  Scenario: Push command without a branch sets
+    Given a basic setup with a puppet module "puppet-test" from "awesome"
+    When I run `msync push --verbose`
+    Then the exit status should be 1
+    And the stderr should contain:
+    """
+    Error: 'branch' option is missing, please set it in configuration or in command line.
+    """
+
+  Scenario: Report the need to clone repositories if sourcecode was not cloned before
+    Given a basic setup with a puppet module "puppet-test" from "awesome"
+    And the global option "branch" sets to "modulesync"
+    When I run `msync push --verbose`
+    Then the exit status should be 1
+    And the stderr should contain:
+    """
+    puppet-test: Repository must be locally available before trying to push
+    """

data/features/reset.feature

@@ -0,0 +1,57 @@
+Feature: reset
+  Reset all repositories
+
+  Scenario: Running first reset to clone repositories
+    Given a basic setup with a puppet module "puppet-test" from "awesome"
+    And the global option "branch" sets to "modulesync"
+    When I successfully run `msync reset --verbose`
+    Then the output should contain "Cloning from 'file://"
+    And the output should not contain "Hard-resetting any local changes to repository in"
+
+  @no-clobber
+  Scenario: Reset when sourcecodes have already been cloned
+    Given the file "modules/awesome/puppet-test/metadata.json" should exist
+    And the global option "branch" sets to "modulesync"
+    When I successfully run `msync reset --verbose`
+    Then the output should not contain "Cloning from 'file://"
+    And the output should contain "Hard-resetting any local changes to repository in 'modules/awesome/puppet-test' from branch 'origin/master'"
+
+  Scenario: Reset after an upstream file addition
+    Given a basic setup with a puppet module "puppet-test" from "awesome"
+    And the global option "branch" sets to "modulesync"
+    And I successfully run `msync reset`
+    Then the file "modules/awesome/puppet-test/hello" should not exist
+    When the puppet module "puppet-test" from "awesome" has a file named "hello" with:
+    """
+    Hello
+    """
+    When I successfully run `msync reset --verbose`
+    Then the output should contain "Hard-resetting any local changes to repository in 'modules/awesome/puppet-test' from branch 'origin/master'"
+    And the file "modules/awesome/puppet-test/hello" should exist
+
+  Scenario: Reset after an upstream file addition in offline mode
+    Given a basic setup with a puppet module "puppet-test" from "awesome"
+    And the global option "branch" sets to "modulesync"
+    And I successfully run `msync reset`
+    Then the file "modules/awesome/puppet-test/hello" should not exist
+    When the puppet module "puppet-test" from "awesome" has a branch named "execute"
+    And the puppet module "puppet-test" from "awesome" has, in branch "execute", a file named "hello" with:
+    """
+    Hello
+    """
+    When I successfully run `msync reset --offline`
+    Then the file "modules/awesome/puppet-test/hello" should not exist
+
+  Scenario: Reset to a specified branch
+    Given a basic setup with a puppet module "puppet-test" from "awesome"
+    And the global option "branch" sets to "modulesync"
+    When the puppet module "puppet-test" from "awesome" has a branch named "other-branch"
+    And the puppet module "puppet-test" from "awesome" has, in branch "other-branch", a file named "hello" with:
+    """
+    Hello
+    """
+    And I successfully run `msync reset`
+    Then the file "modules/awesome/puppet-test/hello" should not exist
+    When I successfully run `msync reset --verbose --source-branch origin/other-branch`
+    And the output should contain "Hard-resetting any local changes to repository in 'modules/awesome/puppet-test' from branch 'origin/other-branch'"
+    Then the file "modules/awesome/puppet-test/hello" should exist

data/features/step_definitions/git_steps.rb

@@ -32,7 +32,20 @@ Given 'a puppet module {string} from {string}' do |name, namespace|
 end
 
 Given 'a git_base option appended to "modulesync.yml" for local tests' do
-  File.write "#{Aruba.config.working_directory}/modulesync.yml", "\ngit_base: #{ModuleSync::Faker::PuppetModuleRemoteRepo.git_base}", mode: 'a'
+  step "the global option 'git_base' sets to '#{ModuleSync::Faker::PuppetModuleRemoteRepo.git_base}'"
+end
+
+Given 'the file {string} appended with:' do |filename, content|
+  File.write filename, "\n#{content}", mode: 'a'
+end
+
+Given 'the global option {string} sets to {string}' do |key, value|
+  steps %(
+    Given the file "#{Aruba.config.working_directory}/modulesync.yml" appended with:
+    """
+    #{key}: #{value}
+    """
+  )
 end
 
 Given 'the puppet module {string} from {string} is read-only' do |name, namespace|
@@ -64,6 +77,16 @@ Given 'the puppet module {string} from {string} has a file named {string} with:'
   pmrr.add_file(filename, content)
 end
 
+Given 'the puppet module {string} from {string} has, in branch {string}, a file named {string} with:' do |name, namespace, branch, filename, content|
+  pmrr = ModuleSync::Faker::PuppetModuleRemoteRepo.new(name, namespace)
+  pmrr.add_file(filename, content, branch)
+end
+
+Given 'the puppet module {string} from {string} has a branch named {string}' do |name, namespace, branch|
+  pmrr = ModuleSync::Faker::PuppetModuleRemoteRepo.new(name, namespace)
+  pmrr.create_branch(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 = ModuleSync::Faker::PuppetModuleRemoteRepo.new(name, namespace)
   expect(pmrr.read_file(filename, branch)).to include(content)
@@ -83,3 +106,8 @@ Then('the puppet module {string} from {string} should not have a tag named {stri
   pmrr = ModuleSync::Faker::PuppetModuleRemoteRepo.new(name, namespace)
   expect(pmrr.tags).not_to include(tag)
 end
+
+Given 'the branch {string} of the puppet module {string} from {string} is deleted' do |branch, name, namespace|
+  pmrr = ModuleSync::Faker::PuppetModuleRemoteRepo.new(name, namespace)
+  pmrr.delete_branch(branch)
+end

data/features/support/env.rb

@@ -1,3 +1,7 @@
+require 'simplecov'
+
+SimpleCov.command_name 'Cucumber'
+
 require 'aruba/cucumber'
 
 require_relative '../../spec/helpers/faker'
@@ -6,4 +10,9 @@ ModuleSync::Faker.working_directory = File.expand_path('faker', Aruba.config.wor
 
 Before do
   @aruba_timeout_seconds = 5
+
+  # This enables coverage when aruba runs `msync` executable (cf. `bin/msync`)
+  set_environment_variable('COVERAGE', '1')
+
+  aruba.config.activate_announcer_on_command_failure = %i[stdout stderr]
 end

data/features/update/bump_version.feature

@@ -16,9 +16,8 @@ Feature: Bump a new version after an update
       """
       <%= @configs['content'] %>
       """
-    When I run `msync update --message "Add new-file" --bump --changelog --tag`
-    Then the exit status should be 0
-    And the file named "modules/fakenamespace/puppet-test/new-file" should contain "aruba"
+    When I successfully run `msync update --verbose --message "Add new-file" --bump --changelog --tag`
+    Then the file named "modules/fakenamespace/puppet-test/new-file" should contain "aruba"
     And the stdout should contain:
       """
       Bumped to version 0.4.3
@@ -44,9 +43,8 @@ Feature: Bump a new version after an update
       """
       <%= @configs['content'] %>
       """
-    When I run `msync update --message "Add new-file" --bump`
-    Then the exit status should be 0
-    And the file named "modules/fakenamespace/puppet-test/new-file" should contain "aruba"
+    When I successfully run `msync update --message "Add new-file" --bump`
+    Then the file named "modules/fakenamespace/puppet-test/new-file" should contain "aruba"
     And the stdout should contain:
       """
       Bumped to version 0.4.3
@@ -67,9 +65,8 @@ Feature: Bump a new version after an update
       """
       <%= @configs['content'] %>
       """
-    When I run `msync update --message "Add new-file" --bump --changelog`
-    Then the exit status should be 0
-    And the file named "modules/fakenamespace/puppet-test/new-file" should contain "aruba"
+    When I successfully run `msync update --message "Add new-file" --bump --changelog`
+    Then the file named "modules/fakenamespace/puppet-test/new-file" should contain "aruba"
     And the stdout should contain:
       """
       Bumped to version 0.4.3
@@ -81,7 +78,6 @@ Feature: Bump a new version after an update
   Scenario: Dont bump the module version after an update that produces no changes
     Given a basic setup with a puppet module "puppet-test" from "fakenamespace"
     And a directory named "moduleroot"
-    When I run `msync update --message "Add new-file" --bump --tag`
-    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 "Add new-file" --bump --tag`
+    Then the puppet module "puppet-test" from "fakenamespace" should have no commits made by "Aruba"
     And the puppet module "puppet-test" from "fakenamespace" should not have a tag named "0.4.3"

data/features/update/dot_sync.feature

@@ -0,0 +1,52 @@
+Feature: Update using a `.sync.yml` file
+  ModuleSync needs to apply templates according to `.sync.yml` content
+
+  Scenario: Updating a module with a .sync.yml file
+    Given a basic setup with a puppet module "puppet-test" from "fakenamespace"
+    And a file named "config_defaults.yml" with:
+      """
+      ---
+      :global:
+        variable: 'global'
+      template_with_specific_config:
+        variable: 'specific'
+      """
+    And a file named "moduleroot/template_with_specific_config.erb" with:
+      """
+      ---
+      <%= @configs['variable'] %>
+      """
+    And a file named "moduleroot/template_with_only_global_config.erb" with:
+      """
+      ---
+      <%= @configs['variable'] %>
+      """
+    And the puppet module "puppet-test" from "fakenamespace" has a branch named "target"
+    And the puppet module "puppet-test" from "fakenamespace" has, in branch "target", a file named ".sync.yml" with:
+      """
+      ---
+      :global:
+        variable: 'overwritten by globally defined value in .sync.yml'
+      template_with_specific_config:
+        variable: 'overwritten by file-specific defined value in .sync.yml'
+      """
+    When I successfully run `msync update --message 'Apply ModuleSync templates to target source code' --branch 'target'`
+    Then the file named "modules/fakenamespace/puppet-test/template_with_specific_config" should contain:
+      """
+      overwritten by file-specific defined value in .sync.yml
+      """
+    And the puppet module "puppet-test" from "fakenamespace" should have 1 commit made by "Aruba"
+    When the puppet module "puppet-test" from "fakenamespace" has, in branch "target", a file named ".sync.yml" with:
+      """
+      ---
+      :global:
+        variable: 'overwritten by globally defined value in .sync.yml'
+      template_with_specific_config:
+        variable: 'overwritten by newly file-specific defined value in .sync.yml'
+      """
+    And I successfully run `msync update --message 'Apply ModuleSync templates to target source code' --branch 'target'`
+    Then the file named "modules/fakenamespace/puppet-test/template_with_specific_config" should contain:
+      """
+      overwritten by newly file-specific defined value in .sync.yml
+      """
+    And the puppet module "puppet-test" from "fakenamespace" should have 2 commits made by "Aruba"

data/features/update/pull_request.feature

@@ -0,0 +1,180 @@
+Feature: Create a pull-request/merge-request after update
+
+  Scenario: Run update in no-op mode and ask for GitHub PR
+    Given a basic setup with a puppet module "puppet-test" from "fakenamespace"
+    And a file named "managed_modules.yml" with:
+      """
+      ---
+      puppet-test:
+        github: {}
+      """
+    And I set the environment variables to:
+      | variable        | value                    |
+      | GITHUB_TOKEN    | foobar                   |
+      | GITHUB_BASE_URL | https://github.example.com |
+    And a file named "config_defaults.yml" with:
+      """
+      ---
+      test:
+        name: aruba
+      """
+    And a file named "moduleroot/test.erb" with:
+      """
+      <%= @configs['name'] %>
+      """
+    When I successfully run `msync update --noop --branch managed_update --pr`
+    Then the output should contain "Would submit PR "
+    And the puppet module "puppet-test" from "fakenamespace" should have no commits made by "Aruba"
+
+  Scenario: Run update in no-op mode and ask for GitLab MR
+    Given a basic setup with a puppet module "puppet-test" from "fakenamespace"
+    And a file named "managed_modules.yml" with:
+      """
+      ---
+      puppet-test:
+        gitlab: {
+          base_url: 'https://gitlab.example.com'
+      }
+      """
+    And I set the environment variables to:
+      | variable     | value  |
+      | GITLAB_TOKEN | foobar |
+    And a file named "config_defaults.yml" with:
+      """
+      ---
+      test:
+        name: aruba
+      """
+    And a file named "moduleroot/test.erb" with:
+      """
+      <%= @configs['name'] %>
+      """
+    When I successfully run `msync update --noop --branch managed_update --pr`
+    Then the output should contain "Would submit MR "
+    And the puppet module "puppet-test" from "fakenamespace" should have no commits made by "Aruba"
+
+  Scenario: Run update without changes in no-op mode and ask for GitLab MR
+    Given a basic setup with a puppet module "puppet-test" from "fakenamespace"
+    And a directory named "moduleroot"
+    And a file named "managed_modules.yml" with:
+      """
+      ---
+      puppet-test:
+        gitlab: {
+          base_url: 'https://gitlab.example.com'
+        }
+      """
+    And I set the environment variables to:
+      | variable     | value  |
+      | GITLAB_TOKEN | foobar |
+    When I successfully run `msync update --noop --branch managed_update --pr`
+    Then the output should not contain "Would submit MR "
+    And the puppet module "puppet-test" from "fakenamespace" should have no commits made by "Aruba"
+
+  Scenario: Ask for PR without credentials
+    Given a basic setup with a puppet module "puppet-test" from "fakenamespace"
+    And a file named "managed_modules.yml" with:
+      """
+      ---
+      puppet-test:
+        gitlab: {
+          base_url: https://gitlab.example.com
+        }
+      """
+    And a file named "config_defaults.yml" with:
+      """
+      ---
+      test:
+        name: aruba
+      """
+    And a file named "moduleroot/test.erb" with:
+      """
+      <%= @configs['name'] %>
+      """
+    When I run `msync update --noop --pr`
+    Then the stderr should contain "A token is required to use services from gitlab"
+    And the exit status should be 1
+    And the puppet module "puppet-test" from "fakenamespace" should have no commits made by "Aruba"
+
+  Scenario: Ask for PR/MR with modules from GitHub and from GitLab
+    Given a basic setup with a puppet module "puppet-github" from "fakenamespace"
+    And a basic setup with a puppet module "puppet-gitlab" from "fakenamespace"
+    And a file named "managed_modules.yml" with:
+      """
+      ---
+      puppet-github:
+        github:
+          base_url: https://github.example.com
+          token: 'secret'
+      puppet-gitlab:
+        gitlab:
+          base_url: https://gitlab.example.com
+          token: 'secret'
+      """
+    And a file named "config_defaults.yml" with:
+      """
+      ---
+      test:
+        name: aruba
+      """
+    And a file named "moduleroot/test.erb" with:
+      """
+      <%= @configs['name'] %>
+      """
+    When I successfully run `msync update --noop --branch managed_update --pr`
+    Then the output should contain "Would submit PR "
+    And the output should contain "Would submit MR "
+    And the puppet module "puppet-github" from "fakenamespace" should have no commits made by "Aruba"
+    And the puppet module "puppet-gitlab" from "fakenamespace" should have no commits made by "Aruba"
+
+  Scenario: Ask for PR with same source and target branch
+    Given a basic setup with a puppet module "puppet-test" from "fakenamespace"
+    And a file named "managed_modules.yml" with:
+      """
+      ---
+      puppet-test:
+        gitlab:
+          token: 'secret'
+          base_url: 'https://gitlab.example.com'
+      """
+    And a file named "config_defaults.yml" with:
+      """
+      ---
+      test:
+        name: aruba
+      """
+    And a file named "moduleroot/test.erb" with:
+      """
+      <%= @configs['name'] %>
+      """
+    When I run `msync update --noop --branch managed_update --pr --pr-target-branch managed_update`
+    Then the stderr should contain "Unable to open a pull request with the same source and target branch: 'managed_update'"
+    And the exit status should be 1
+    And the puppet module "puppet-test" from "fakenamespace" should have no commits made by "Aruba"
+
+  Scenario: Ask for PR with the default branch as source and target
+    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 "custom_default_branch"
+    And a file named "managed_modules.yml" with:
+      """
+      ---
+      puppet-test:
+        github:
+          token: 'secret'
+          base_url: 'https://gitlab.example.com'
+      """
+    And a file named "config_defaults.yml" with:
+      """
+      ---
+      test:
+        name: aruba
+      """
+    And a file named "moduleroot/test.erb" with:
+      """
+      <%= @configs['name'] %>
+      """
+    And a directory named "moduleroot"
+    When I run `msync update --noop --pr`
+    Then the stderr should contain "Unable to open a pull request with the same source and target branch: 'custom_default_branch'"
+    And the exit status should be 1
+    And the puppet module "puppet-test" from "fakenamespace" should have no commits made by "Aruba"