hybrid_platforms_conductor 32.13.4 → 32.16.2

data/spec/hybrid_platforms_conductor_test/api/platform_handlers/serverless_chef/services_deployment_spec.rb

@@ -0,0 +1,272 @@
+describe HybridPlatformsConductor::HpcPlugins::PlatformHandler::ServerlessChef do
+
+  context 'checking services deployment' do
+
+    # Simulate a packaging of a given repository
+    #
+    # Parameters::
+    # * *repository* (String): The repository we package
+    # * *service* (String): The service being packaged in this repository [default: 'test_policy']
+    def mock_package(repository, service: 'test_policy')
+      FileUtils.mkdir_p "#{repository}/dist/prod/#{service}"
+    end
+
+    # Get expected actions to deploy a service on a given node
+    #
+    # Parameters::
+    # * *repository* (String): Platform repository
+    # * *check_mode* (Boolean): Are we expected check-mode? [default: false]
+    # * *sudo* (String): sudo prefix command [default: 'sudo -u root ']
+    # * *env* (String): Environment expected to be packaged [default: 'prod']
+    # * *policy* (String): Expected policy to be packaged [default: 'test_policy']
+    # * *node* (String): Expected node to be deployed [default: 'node']
+    # Result::
+    # * Array: Expected actions
+    def expected_actions_to_deploy_chef(
+      repository,
+      check_mode: false,
+      sudo: 'sudo -u root ',
+      env: 'prod',
+      policy: 'test_policy',
+      node: 'node'
+    )
+      [
+        {
+          remote_bash: [
+            'set -e',
+            'set -o pipefail',
+            "if [ -n \"$(command -v apt)\" ]; then #{sudo}apt update && #{sudo}apt install -y curl build-essential ; else #{sudo}yum groupinstall 'Development Tools' && #{sudo}yum install -y curl ; fi",
+            'mkdir -p ./hpc_deploy',
+            'rm -rf ./hpc_deploy/tmp',
+            'mkdir -p ./hpc_deploy/tmp',
+            'curl --location https://omnitruck.chef.io/install.sh --output ./hpc_deploy/install.sh',
+            'chmod a+x ./hpc_deploy/install.sh',
+            "#{sudo}TMPDIR=./hpc_deploy/tmp ./hpc_deploy/install.sh -d /opt/artefacts -v 17.0 -s once"
+          ]
+        },
+        {
+          scp: { "#{repository}/dist/#{env}/#{policy}" => './hpc_deploy' },
+          remote_bash: [
+            'set -e',
+            "cd ./hpc_deploy/#{policy}",
+            "#{sudo}SSL_CERT_DIR=/etc/ssl/certs /opt/chef/bin/chef-client --local-mode --chef-license accept --json-attributes nodes/#{node}.json#{check_mode ? ' --why-run' : ''}",
+            'cd ..',
+            "#{sudo}rm -rf ./hpc_deploy/#{policy}"
+          ]
+        }
+      ]
+    end
+
+    context 'with an empty platform' do
+
+      it 'prepares for deploy' do
+        with_serverless_chef_platforms('empty') do |platform, repository|
+          platform.prepare_for_deploy(
+            services: {},
+            secrets: {},
+            local_environment: false,
+            why_run: false
+          )
+        end
+      end
+
+      it 'prepares for deploy in why-run mode' do
+        with_serverless_chef_platforms('empty') do |platform, repository|
+          platform.prepare_for_deploy(
+            services: {},
+            secrets: {},
+            local_environment: false,
+            why_run: true
+          )
+        end
+      end
+
+      it 'prepares for deploy in local mode' do
+        with_serverless_chef_platforms('empty') do |platform, repository|
+          platform.prepare_for_deploy(
+            services: {},
+            secrets: {},
+            local_environment: true,
+            why_run: false
+          )
+        end
+      end
+
+    end
+
+    context 'with a platform having 1 node' do
+
+      it 'returns actions to deploy on this node' do
+        with_serverless_chef_platforms('1_node') do |platform, repository|
+          mock_package(repository)
+          platform.prepare_for_deploy(
+            services: { 'node' => %w[test_policy] },
+            secrets: {},
+            local_environment: false,
+            why_run: false
+          )
+          expect(platform.actions_to_deploy_on('node', 'test_policy', use_why_run: false)).to eq expected_actions_to_deploy_chef(repository)
+        end
+      end
+
+      it 'returns actions to deploy on this node with node attributes setup from metadata' do
+        with_serverless_chef_platforms('1_node') do |platform, repository|
+          test_nodes_handler.override_metadata_of 'node', :new_metadata, 'new_value'
+          mock_package(repository)
+          platform.prepare_for_deploy(
+            services: { 'node' => %w[test_policy] },
+            secrets: {},
+            local_environment: false,
+            why_run: false
+          )
+          expect(platform.actions_to_deploy_on('node', 'test_policy', use_why_run: false)).to eq expected_actions_to_deploy_chef(repository)
+          attributes_file = "#{repository}/dist/prod/test_policy/nodes/node.json"
+          expect(File.exist?(attributes_file)).to eq true
+          expect(JSON.parse(File.read(attributes_file))).to eq(
+            'description' => 'Single test node',
+            'image' => 'debian_9',
+            'new_metadata' => 'new_value',
+            'private_ips' => ['172.16.0.1'],
+            'property1' => { 'property11' => 'value11' },
+            'property2' => 'value2',
+          )
+        end
+      end
+
+      it 'returns actions to deploy on this node with secrets' do
+        with_serverless_chef_platforms('1_node') do |platform, repository|
+          mock_package(repository)
+          platform.prepare_for_deploy(
+            services: { 'node' => %w[test_policy] },
+            secrets: { 'my_secret' => 'secret_value' },
+            local_environment: false,
+            why_run: false
+          )
+          expect(platform.actions_to_deploy_on('node', 'test_policy', use_why_run: false)).to eq expected_actions_to_deploy_chef(repository)
+        end
+      end
+
+      it 'returns actions to deploy on this node in why-run mode' do
+        with_serverless_chef_platforms('1_node') do |platform, repository|
+          mock_package(repository)
+          platform.prepare_for_deploy(
+            services: { 'node' => %w[test_policy] },
+            secrets: {},
+            local_environment: false,
+            why_run: true
+          )
+          expect(platform.actions_to_deploy_on('node', 'test_policy', use_why_run: true)).to eq expected_actions_to_deploy_chef(repository, check_mode: true)
+        end
+      end
+
+      it 'returns actions to deploy on this node using local mode' do
+        with_serverless_chef_platforms('1_node') do |platform, repository|
+          mock_package(repository)
+          platform.prepare_for_deploy(
+            services: { 'node' => %w[test_policy] },
+            secrets: {},
+            local_environment: true,
+            why_run: false
+          )
+          expect(platform.actions_to_deploy_on('node', 'test_policy', use_why_run: false)).to eq expected_actions_to_deploy_chef(repository, env: 'local')
+        end
+      end
+
+      it 'returns actions to deploy on this node in why-run mode and local mode' do
+        with_serverless_chef_platforms('1_node') do |platform, repository|
+          mock_package(repository)
+          platform.prepare_for_deploy(
+            services: { 'node' => %w[test_policy] },
+            secrets: {},
+            local_environment: true,
+            why_run: true
+          )
+          expect(platform.actions_to_deploy_on('node', 'test_policy', use_why_run: true)).to eq expected_actions_to_deploy_chef(repository, env: 'local', check_mode: true)
+        end
+      end
+
+      it 'returns actions to deploy on this node using root user' do
+        with_serverless_chef_platforms('1_node') do |platform, repository|
+          test_actions_executor.connector(:ssh).ssh_user = 'root'
+          mock_package(repository)
+          platform.prepare_for_deploy(
+            services: { 'node' => %w[test_policy] },
+            secrets: {},
+            local_environment: false,
+            why_run: false
+          )
+          expect(platform.actions_to_deploy_on('node', 'test_policy', use_why_run: false)).to eq expected_actions_to_deploy_chef(repository, sudo: '')
+        end
+      end
+
+      it 'fails with a nice message when chef_versions.yml is missing' do
+        with_serverless_chef_platforms('1_node') do |platform, repository|
+          mock_package(repository)
+          platform.prepare_for_deploy(
+            services: { 'node' => %w[test_policy] },
+            secrets: {},
+            local_environment: false,
+            why_run: false
+          )
+          File.unlink("#{repository}/chef_versions.yml")
+          expect { platform.actions_to_deploy_on('node', 'test_policy', use_why_run: false) }.to raise_error "Missing file #{repository}/chef_versions.yml specifying the Chef Infra Client version to be deployed"
+        end
+      end
+
+    end
+
+    context 'with a platform having several nodes' do
+
+      it 'deploys services declared on 1 node on another node if asked' do
+        with_serverless_chef_platforms('several_nodes') do |platform, repository|
+          mock_package(repository)
+          platform.prepare_for_deploy(
+            services: { 'node2' => %w[test_policy_1] },
+            secrets: {},
+            local_environment: false,
+            why_run: false
+          )
+          expect(platform.actions_to_deploy_on('node2', 'test_policy_1', use_why_run: false)).to eq expected_actions_to_deploy_chef(repository, policy: 'test_policy_1', node: 'node2')
+        end
+      end
+
+      it 'deploys local nodes' do
+        with_serverless_chef_platforms('several_nodes') do |platform, repository|
+          mock_package(repository)
+          platform.prepare_for_deploy(
+            services: { 'local' => %w[test_policy_1] },
+            secrets: {},
+            local_environment: false,
+            why_run: false
+          )
+          expect(platform.actions_to_deploy_on('local', 'test_policy_1', use_why_run: false)).to eq [
+            {
+              bash: "cd #{repository}/dist/prod/test_policy_1 && sudo SSL_CERT_DIR=/etc/ssl/certs /opt/chef-workstation/bin/chef-client --local-mode --chef-license accept --json-attributes nodes/local.json"
+            }
+          ]
+        end
+      end
+
+    end
+
+    context 'with 2 platforms' do
+
+      it 'deploys a service on a node belonging to another platform' do
+        with_serverless_chef_platforms({ 'p1' => '1_node', 'p2' => 'several_nodes' }) do |repositories|
+          platform_p1, repository_p1 = repositories.find { |platform, _repository| platform.name == 'p1' }
+          mock_package(repository_p1)
+          platform_p1.prepare_for_deploy(
+            services: { 'node2' => %w[test_policy_1] },
+            secrets: {},
+            local_environment: false,
+            why_run: false
+          )
+          expect(platform_p1.actions_to_deploy_on('node2', 'test_policy_1', use_why_run: false)).to eq expected_actions_to_deploy_chef(repository_p1, policy: 'test_policy_1', node: 'node2')
+        end
+      end
+
+    end
+
+  end
+
+end

data/spec/hybrid_platforms_conductor_test/helpers/cmd_runner_helpers.rb

@@ -31,7 +31,7 @@ module HybridPlatformsConductorTest
         end
         # We need to protect the access to this array as the mocked commands can be called by competing threads
         remaining_expected_commands_mutex = Mutex.new
-        allow(cmd_runner).to receive(:run_cmd) do |cmd, log_to_file: nil, log_to_stdout: true, log_stdout_to_io: nil, log_stderr_to_io: nil, expected_code: 0, timeout: nil, no_exception: false|
+        allow(cmd_runner).to receive(:run_cmd) do |cmd, log_to_file: nil, log_to_stdout: true, log_stdout_to_io: nil, log_stderr_to_io: nil, expected_code: 0, timeout: nil, no_exception: false, force_bash: false|
           # Check the remaining expected commands
           found_command = nil
           found_command_code = nil

data/spec/hybrid_platforms_conductor_test/helpers/serverless_chef_helpers.rb

@@ -0,0 +1,53 @@
+require 'hybrid_platforms_conductor/hpc_plugins/platform_handler/serverless_chef'
+
+module HybridPlatformsConductorTest
+
+  module Helpers
+
+    module ServerlessChefHelpers
+
+      # Setup a platforms config using test repository names
+      #
+      # Parameters::
+      # * *names* (String or Hash<String, String>): The test repository name (taken from the repositories/ folder), or a Hash of names and their corresponding test repository source name
+      # * *additional_config* (String): Additional config to append after the platform declaration [default: '']
+      # * *as_git* (Boolean): Should we initialize the repository as a git repo? [default: false]
+      # * Proc: Code called when repository is setup
+      #   * Parameters::
+      #     If there was only 1 repository:
+      #     * *platform* (PlatformHandler): The platform handler to be tested
+      #     * *repository* (String): Repository path
+      #     If there was multiple repositories:
+      #     * *repositories* (Hash<PlatformHandler,String>): Set of repositories, per platform handler
+      def with_serverless_chef_platforms(names, additional_config: '', as_git: false)
+        names = { names => names } unless names.is_a?(Hash)
+        with_repositories(names.keys, as_git: as_git) do |repositories|
+          repositories.each do |name, repository|
+            # Copy the content of the test repository in the temporary one
+            FileUtils.cp_r "#{__dir__}/../serverless_chef_repositories/#{names[name]}/.", repository
+          end
+          with_platforms(repositories.values.map { |repository| "serverless_chef_platform path: '#{repository}'\n" }.join + additional_config) do
+            repositories = Hash[names.keys.map do |name|
+              [
+                test_platforms_handler.platform(name),
+                repositories[name]
+              ]
+            end]
+            test_platforms_handler.inject_dependencies(
+              nodes_handler: test_nodes_handler,
+              actions_executor: test_actions_executor
+            )
+            if repositories.size == 1
+              yield *repositories.first
+            else
+              yield repositories
+            end
+          end
+        end
+      end
+
+    end
+
+  end
+
+end

data/spec/hybrid_platforms_conductor_test/serverless_chef_repositories/1_node/chef_versions.yml

@@ -0,0 +1,3 @@
+---
+workstation: '21.5'
+client: '17.0'

data/spec/hybrid_platforms_conductor_test/serverless_chef_repositories/1_node/nodes/node.json

@@ -0,0 +1,14 @@
+{
+  "name": "node",
+  "normal": {
+    "description": "Single test node",
+    "image": "debian_9",
+    "private_ips": ["172.16.0.1"],
+    "property1": {
+      "property11": "value11"
+    },
+    "property2": "value2"
+  },
+  "policy_name": "test_policy",
+  "policy_group": "test_group"
+}

data/spec/hybrid_platforms_conductor_test/serverless_chef_repositories/1_node/policyfiles/test_policy.rb

@@ -0,0 +1,3 @@
+name File.basename(__FILE__, '.rb')
+default_source :supermarket
+run_list 'recipe[test_cookbook]'

data/spec/hybrid_platforms_conductor_test/serverless_chef_repositories/data_bags/chef_versions.yml

@@ -0,0 +1,3 @@
+---
+workstation: '21.5'
+client: '17.0'

data/spec/hybrid_platforms_conductor_test/serverless_chef_repositories/data_bags/data_bags/my_bag/my_item.json

@@ -0,0 +1,4 @@
+{
+  "id": "my_item",
+  "content": "Bag content"
+}

data/spec/hybrid_platforms_conductor_test/serverless_chef_repositories/data_bags/nodes/node.json

@@ -0,0 +1,14 @@
+{
+  "name": "node",
+  "normal": {
+    "description": "Single test node",
+    "image": "debian_9",
+    "private_ips": ["172.16.0.1"],
+    "property1": {
+      "property11": "value11"
+    },
+    "property2": "value2"
+  },
+  "policy_name": "test_policy",
+  "policy_group": "test_group"
+}

data/spec/hybrid_platforms_conductor_test/serverless_chef_repositories/data_bags/policyfiles/test_policy.rb

@@ -0,0 +1,3 @@
+name File.basename(__FILE__, '.rb')
+default_source :supermarket
+run_list 'recipe[test_cookbook]'

data/spec/hybrid_platforms_conductor_test/serverless_chef_repositories/hpc_test/chef_versions.yml

@@ -0,0 +1,3 @@
+---
+workstation: '21.5'
+client: '17.0'

data/spec/hybrid_platforms_conductor_test/serverless_chef_repositories/hpc_test/cookbooks/hpc_test/recipes/after_run.rb

@@ -0,0 +1 @@
+# Recipe

data/spec/hybrid_platforms_conductor_test/serverless_chef_repositories/hpc_test/cookbooks/hpc_test/recipes/before_run.rb

@@ -0,0 +1 @@
+# Recipe

data/spec/hybrid_platforms_conductor_test/serverless_chef_repositories/hpc_test/nodes/node.json

@@ -0,0 +1,10 @@
+{
+  "name": "node",
+  "normal": {
+    "description": "Single test node",
+    "image": "debian_9",
+    "private_ips": ["172.16.0.1"]
+  },
+  "policy_name": "test_policy",
+  "policy_group": "test_group"
+}

data/spec/hybrid_platforms_conductor_test/serverless_chef_repositories/hpc_test/policyfiles/test_policy.rb

@@ -0,0 +1,3 @@
+name File.basename(__FILE__, '.rb')
+default_source :supermarket
+run_list 'recipe[test_cookbook]'

data/spec/hybrid_platforms_conductor_test/serverless_chef_repositories/recipes/cookbooks/test_cookbook_1/recipes/default.rb

@@ -0,0 +1 @@
+# Default recipe

data/spec/hybrid_platforms_conductor_test/serverless_chef_repositories/recipes/cookbooks/test_cookbook_2/libraries/default.rb

@@ -0,0 +1,4 @@
+# Library code
+
+def my_library_helper(arg)
+end

data/spec/hybrid_platforms_conductor_test/serverless_chef_repositories/recipes/cookbooks/test_cookbook_2/recipes/default.rb

@@ -0,0 +1 @@
+# Recipe code

data/spec/hybrid_platforms_conductor_test/serverless_chef_repositories/recipes/cookbooks/test_cookbook_2/recipes/other_recipe.rb

@@ -0,0 +1 @@
+# Recipe code

data/spec/hybrid_platforms_conductor_test/serverless_chef_repositories/recipes/cookbooks/test_cookbook_2/resources/my_resource.rb

@@ -0,0 +1 @@
+# Resource code

data/spec/hybrid_platforms_conductor_test/serverless_chef_repositories/recipes/nodes/node1.json

@@ -0,0 +1,10 @@
+{
+  "name": "node1",
+  "normal": {
+    "description": "Node 1",
+    "image": "debian_9",
+    "private_ips": ["172.16.0.1"]
+  },
+  "policy_name": "test_policy_1",
+  "policy_group": "test_group"
+}