hybrid_platforms_conductor 32.3.6

data/spec/hybrid_platforms_conductor_test/cmdb_plugins/test_cmdb_others2.rb

@@ -0,0 +1,58 @@
+module HybridPlatformsConductorTest
+
+  module CmdbPlugins
+
+    # CMDB plugin that can be piloted by test cases to test how NodesHandler is using such plugins
+    class TestCmdbOthers2 < HybridPlatformsConductor::Cmdb
+
+      # Return the calls made to this plugin
+      # Array< [String,      Object, Object...] >
+      # Array< [method_name, arg1,   arg2...  ] >
+      attr_accessor :calls
+
+      # get_* methods are automatically detected as possible metadata properties this plugin can fill.
+      # The property name filled by such method is given by the method's name: get_my_property will fill the :my_property metadata.
+      # The method get_others is used specifically to return properties whose name is unknown before fetching them.
+
+      # Get other properties for a given set of nodes.
+      # It's better to not use this method and prefer using methods naming the property being returned.
+      # As the nodes_handler can't know in advance which properties will be returned, it will call it every time there is a missing property.
+      # If this method always returns the same values, it would be clever to cache it here.
+      # [API] - This method is optional.
+      # [API] - @nodes_handler can be used.
+      # [API] - @cmd_runner can be used.
+      #
+      # Parameters::
+      # * *nodes* (Array<String>): The nodes to lookup the property for.
+      # * *metadata* (Hash<String, Hash<Symbol,Object> >): Existing metadata for each node. Dependent properties should be present here.
+      # Result::
+      # * Hash<String, Hash<Symbol,Object> >: The corresponding properties, per required node.
+      #     Nodes for which the property can't be fetched can be ommitted.
+      def get_others(nodes, metadata)
+        record_call(:get_others, nodes, metadata)
+        Hash[nodes.map do |node|
+          [
+            node,
+            {
+              downcase: "__#{node}__"
+            }
+          ]
+        end]
+      end
+
+      # Register a call to be checked by the tests later
+      #
+      # Parameters::
+      # * *method* (Symbol): Method being called
+      # * *args* (Array<Object>): Arguments given to the call
+      def record_call(method, *args)
+        @calls = [] unless defined?(@calls)
+        # Create a shallow copy of the args, just to make sure they won't get changed by later code
+        @calls << [method] + Marshal.load(Marshal.dump(args))
+      end
+
+    end
+
+  end
+
+end

data/spec/hybrid_platforms_conductor_test/executables/check-node_spec.rb

@@ -0,0 +1,35 @@
+describe 'check-node executable' do
+
+  # Setup a platform for check-node tests
+  #
+  # Parameters::
+  # * Proc: Code called when the platform is setup
+  #   * Parameters::
+  #     * *repository* (String): Platform's repository
+  def with_test_platform_for_check_node
+    with_test_platform({ nodes: { 'node' => {} } }) do |repository|
+      yield repository
+    end
+  end
+
+  it 'checks a given node' do
+    with_test_platform_for_check_node do
+      expect(test_deployer).to receive(:deploy_on).with('node') do
+        expect(test_deployer.use_why_run).to eq true
+        test_deployer.stdout_device << "Check ok\n"
+        { 'node' => [0, "Check ok\n", ''] }
+      end
+      exit_code, stdout, stderr = run 'check-node', '--node', 'node'
+      expect(exit_code).to eq 0
+      expect(stdout).to match /Check ok/
+      expect(stderr).to eq ''
+    end
+  end
+
+  it 'fails if no node is given' do
+    with_test_platform_for_check_node do
+      expect { run 'check-node' }.to raise_error(RuntimeError, 'No node selected. Please use --node option to set at least one.')
+    end
+  end
+
+end

data/spec/hybrid_platforms_conductor_test/executables/deploy_spec.rb

@@ -0,0 +1,35 @@
+describe 'deploy executable' do
+
+  # Setup a platform for deploy tests
+  #
+  # Parameters::
+  # * Proc: Code called when the platform is setup
+  #   * Parameters::
+  #     * *repository* (String): Platform's repository
+  def with_test_platform_for_deploy
+    with_test_platform({ nodes: { 'node' => {} } }) do |repository|
+      yield repository
+    end
+  end
+
+  it 'deploys a given node' do
+    with_test_platform_for_deploy do
+      expect(test_deployer).to receive(:deploy_on).with(['node']) do
+        expect(test_deployer.use_why_run).to eq false
+        test_deployer.stdout_device << "Deploy ok\n"
+        { 'node' => [0, "Deploy ok\n", ''] }
+      end
+      exit_code, stdout, stderr = run 'deploy', '--node', 'node'
+      expect(exit_code).to eq 0
+      expect(stdout).to match /Deploy ok/
+      expect(stderr).to eq ''
+    end
+  end
+
+  it 'fails if no node is given' do
+    with_test_platform_for_deploy do
+      expect { run 'deploy' }.to raise_error(RuntimeError, 'No node selected. Please use --node option to set at least one.')
+    end
+  end
+
+end

data/spec/hybrid_platforms_conductor_test/executables/get_impacted_nodes_spec.rb

@@ -0,0 +1,158 @@
+describe 'get_impacted_nodes executable' do
+
+  # Setup a platform for get_impacted_nodes tests
+  #
+  # Parameters::
+  # * Proc: Code called when the platform is setup
+  #   * Parameters::
+  #     * *repository* (String): Platform's repository
+  def with_test_platform_for_get_impacted_nodes
+    with_test_platform(
+      {
+        nodes: {
+          'node1' => { services: %w[service1] },
+          'node2' => { services: %w[service2] }
+        }
+      }
+    ) do |repository|
+      yield repository
+    end
+  end
+
+  it 'returns nodes impacted by a git diff' do
+    with_test_platform_for_get_impacted_nodes do
+      expect(test_nodes_handler).to receive(:impacted_nodes_from_git_diff).with(
+        'platform',
+        from_commit: 'master',
+        to_commit: nil,
+        smallest_set: false
+      ) { [%w[node1 node2], %w[node1], %w[service2], false] }
+      exit_code, stdout, stderr = run 'get_impacted_nodes', '--platform', 'platform'
+      expect(exit_code).to eq 0
+      expect(stdout).to eq <<~EOS
+       
+       * 1 impacted services:
+       service2
+       
+       * 1 impacted nodes (directly):
+       node1
+       
+       * 2 impacted nodes (total):
+       node1
+       node2
+
+      EOS
+      expect(stderr).to eq ''
+    end
+  end
+
+  it 'returns nodes impacted by a git diff changing all nodes' do
+    with_test_platform_for_get_impacted_nodes do
+      expect(test_nodes_handler).to receive(:impacted_nodes_from_git_diff).with(
+        'platform',
+        from_commit: 'master',
+        to_commit: nil,
+        smallest_set: false
+      ) { [%w[node1 node2], %w[node1], %w[service2], true] }
+      exit_code, stdout, stderr = run 'get_impacted_nodes', '--platform', 'platform'
+      expect(exit_code).to eq 0
+      expect(stdout).to eq <<~EOS
+       * Potentially all nodes of this platform are impacted.
+       
+       * 1 impacted services:
+       service2
+       
+       * 1 impacted nodes (directly):
+       node1
+       
+       * 2 impacted nodes (total):
+       node1
+       node2
+
+      EOS
+      expect(stderr).to eq ''
+    end
+  end
+
+  it 'returns nodes impacted by a git diff with from commit' do
+    with_test_platform_for_get_impacted_nodes do
+      expect(test_nodes_handler).to receive(:impacted_nodes_from_git_diff).with(
+        'platform',
+        from_commit: 'from_commit',
+        to_commit: nil,
+        smallest_set: false
+      ) { [%w[node1 node2], %w[node1], %w[service2], false] }
+      exit_code, stdout, stderr = run 'get_impacted_nodes', '--platform', 'platform', '--from-commit', 'from_commit'
+      expect(exit_code).to eq 0
+      expect(stdout).to eq <<~EOS
+       
+       * 1 impacted services:
+       service2
+       
+       * 1 impacted nodes (directly):
+       node1
+       
+       * 2 impacted nodes (total):
+       node1
+       node2
+
+      EOS
+      expect(stderr).to eq ''
+    end
+  end
+
+  it 'returns nodes impacted by a git diff with to commit' do
+    with_test_platform_for_get_impacted_nodes do
+      expect(test_nodes_handler).to receive(:impacted_nodes_from_git_diff).with(
+        'platform',
+        from_commit: 'master',
+        to_commit: 'to_commit',
+        smallest_set: false
+      ) { [%w[node1 node2], %w[node1], %w[service2], false] }
+      exit_code, stdout, stderr = run 'get_impacted_nodes', '--platform', 'platform', '--to-commit', 'to_commit'
+      expect(exit_code).to eq 0
+      expect(stdout).to eq <<~EOS
+       
+       * 1 impacted services:
+       service2
+       
+       * 1 impacted nodes (directly):
+       node1
+       
+       * 2 impacted nodes (total):
+       node1
+       node2
+
+      EOS
+      expect(stderr).to eq ''
+    end
+  end
+
+  it 'returns nodes impacted by a git diff with smallest test sample' do
+    with_test_platform_for_get_impacted_nodes do
+      expect(test_nodes_handler).to receive(:impacted_nodes_from_git_diff).with(
+        'platform',
+        from_commit: 'master',
+        to_commit: nil,
+        smallest_set: true
+      ) { [%w[node1 node2], %w[node1], %w[service2], false] }
+      exit_code, stdout, stderr = run 'get_impacted_nodes', '--platform', 'platform', '--smallest-test-sample'
+      expect(exit_code).to eq 0
+      expect(stdout).to eq <<~EOS
+       
+       * 1 impacted services:
+       service2
+       
+       * 1 impacted nodes (directly):
+       node1
+       
+       * 2 impacted nodes (total smallest set):
+       node1
+       node2
+
+      EOS
+      expect(stderr).to eq ''
+    end
+  end
+
+end

data/spec/hybrid_platforms_conductor_test/executables/last_deploys_spec.rb

@@ -0,0 +1,173 @@
+describe 'last_deploys executable' do
+
+  # Setup a platform for last_deploys tests
+  #
+  # Parameters::
+  # * Proc: Code called when the platform is setup
+  #   * Parameters::
+  #     * *repository* (String): Platform's repository
+  def with_test_platform_for_last_deploys
+    with_test_platform({ nodes: { 'node1' => {}, 'node2' => {} } }) do |repository|
+      yield repository
+    end
+  end
+
+  it 'checks all nodes by default' do
+    with_test_platform_for_last_deploys do
+      expect_actions_executor_runs([proc do |actions, timeout: nil, concurrent: false, log_to_dir: 'run_logs', log_to_stdout: true|
+        expect(actions).to eq(
+          'node1' => { remote_bash: "cd /var/log/deployments && ls -t | head -1 | xargs sed '/===== STDOUT =====/q'" },
+          'node2' => { remote_bash: "cd /var/log/deployments && ls -t | head -1 | xargs sed '/===== STDOUT =====/q'" }
+        )
+        {
+          'node1' => [0, <<~EOS, ''],
+            date: 2019-08-21 10:12:15
+            user: admin_user1
+            services: service1
+          EOS
+          'node2' => [0, <<~EOS, '']
+            date: 2019-08-22 10:12:15
+            user: admin_user2
+            services: service1, service2
+          EOS
+        }
+      end])
+      exit_code, stdout, stderr = run 'last_deploys'
+      expect(exit_code).to eq 0
+      expect(stdout).to eq(<<~EOS)
+        +-------+---------------------+-------------+--------------------+-------+
+        | Node  | Date                | Admin       | Services           | Error |
+        +-------+---------------------+-------------+--------------------+-------+
+        | node1 | 2019-08-21 10:12:15 | admin_user1 | service1           |       |
+        | node2 | 2019-08-22 10:12:15 | admin_user2 | service1, service2 |       |
+        +-------+---------------------+-------------+--------------------+-------+
+      EOS
+      expect(stderr).to eq ''
+    end
+  end
+
+  it 'sorts results by user' do
+    with_test_platform_for_last_deploys do
+      expect_actions_executor_runs([proc do |actions, timeout: nil, concurrent: false, log_to_dir: 'run_logs', log_to_stdout: true|
+        expect(actions).to eq(
+          'node1' => { remote_bash: "cd /var/log/deployments && ls -t | head -1 | xargs sed '/===== STDOUT =====/q'" },
+          'node2' => { remote_bash: "cd /var/log/deployments && ls -t | head -1 | xargs sed '/===== STDOUT =====/q'" }
+        )
+        {
+          'node1' => [0, <<~EOS, ''],
+            date: 2019-08-21 10:12:15
+            user: admin_user2
+            services: service1
+          EOS
+          'node2' => [0, <<~EOS, '']
+            date: 2019-08-22 10:12:15
+            user: admin_user1
+            services: service1, service2
+          EOS
+        }
+      end])
+      exit_code, stdout, stderr = run 'last_deploys', '--sort-by', 'user'
+      expect(exit_code).to eq 0
+      expect(stdout).to eq(<<~EOS)
+        +-------+---------------------+-------------+--------------------+-------+
+        | Node  | Date                | Admin       | Services           | Error |
+        +-------+---------------------+-------------+--------------------+-------+
+        | node2 | 2019-08-22 10:12:15 | admin_user1 | service1, service2 |       |
+        | node1 | 2019-08-21 10:12:15 | admin_user2 | service1           |       |
+        +-------+---------------------+-------------+--------------------+-------+
+      EOS
+      expect(stderr).to eq ''
+    end
+  end
+
+  it 'sorts results by user descending' do
+    with_test_platform_for_last_deploys do
+      expect_actions_executor_runs([proc do |actions, timeout: nil, concurrent: false, log_to_dir: 'run_logs', log_to_stdout: true|
+        expect(actions).to eq(
+          'node1' => { remote_bash: "cd /var/log/deployments && ls -t | head -1 | xargs sed '/===== STDOUT =====/q'" },
+          'node2' => { remote_bash: "cd /var/log/deployments && ls -t | head -1 | xargs sed '/===== STDOUT =====/q'" }
+        )
+        {
+          'node1' => [0, <<~EOS, ''],
+            date: 2019-08-21 10:12:15
+            user: admin_user2
+            services: service1
+          EOS
+          'node2' => [0, <<~EOS, '']
+            date: 2019-08-22 10:12:15
+            user: admin_user1
+            services: service1, service2
+          EOS
+        }
+      end])
+      exit_code, stdout, stderr = run 'last_deploys', '--sort-by', 'user_desc'
+      expect(exit_code).to eq 0
+      expect(stdout).to eq(<<~EOS)
+        +-------+---------------------+-------------+--------------------+-------+
+        | Node  | Date                | Admin       | Services           | Error |
+        +-------+---------------------+-------------+--------------------+-------+
+        | node1 | 2019-08-21 10:12:15 | admin_user2 | service1           |       |
+        | node2 | 2019-08-22 10:12:15 | admin_user1 | service1, service2 |       |
+        +-------+---------------------+-------------+--------------------+-------+
+      EOS
+      expect(stderr).to eq ''
+    end
+  end
+
+  it 'displays only the selected nodes' do
+    with_test_platform_for_last_deploys do
+      expect_actions_executor_runs([proc do |actions, timeout: nil, concurrent: false, log_to_dir: 'run_logs', log_to_stdout: true|
+        expect(actions).to eq('node1' => { remote_bash: "cd /var/log/deployments && ls -t | head -1 | xargs sed '/===== STDOUT =====/q'" })
+        {
+          'node1' => [0, <<~EOS, ''],
+            date: 2019-08-21 10:12:15
+            user: admin_user1
+            services: service1
+          EOS
+        }
+      end])
+      exit_code, stdout, stderr = run 'last_deploys', '--node', 'node1'
+      expect(exit_code).to eq 0
+      expect(stdout).to eq(<<~EOS)
+        +-------+---------------------+-------------+----------+-------+
+        | Node  | Date                | Admin       | Services | Error |
+        +-------+---------------------+-------------+----------+-------+
+        | node1 | 2019-08-21 10:12:15 | admin_user1 | service1 |       |
+        +-------+---------------------+-------------+----------+-------+
+      EOS
+      expect(stderr).to eq ''
+    end
+  end
+
+  it 'displays errors when we can\'t get info from some nodes' do
+    with_test_platform_for_last_deploys do
+      expect_actions_executor_runs([proc do |actions, timeout: nil, concurrent: false, log_to_dir: 'run_logs', log_to_stdout: true|
+        expect(actions).to eq(
+          'node1' => { remote_bash: "cd /var/log/deployments && ls -t | head -1 | xargs sed '/===== STDOUT =====/q'" },
+          'node2' => { remote_bash: "cd /var/log/deployments && ls -t | head -1 | xargs sed '/===== STDOUT =====/q'" }
+        )
+        {
+          'node1' => [:connection_error, 'Error on stdout', 'Error on stderr'],
+          'node2' => [0, <<~EOS, '']
+            date: 2019-08-22 10:12:15
+            user: admin_user1
+            services: service1, service2
+          EOS
+        }
+      end])
+      exit_code, stdout, stderr = run 'last_deploys', '--sort-by', 'user_desc'
+      expect(exit_code).to eq 0
+      expect(stdout).to eq(<<~EOS)
+        +-------+---------------------+-------------+--------------------+-------------------------+
+        | Node  | Date                | Admin       | Services           | Error                   |
+        +-------+---------------------+-------------+--------------------+-------------------------+
+        | node2 | 2019-08-22 10:12:15 | admin_user1 | service1, service2 |                         |
+        | node1 |                     |             |                    | Error: connection_error |
+        |       |                     |             |                    | Error on stderr         |
+        +-------+---------------------+-------------+--------------------+-------------------------+
+      EOS
+      expect(stderr).to eq ''
+    end
+  end
+
+end