hybrid_platforms_conductor 32.3.6 → 32.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e16a6630a51ed9208fa4a3cecfce6604c65a39cb782d9efa426898ec980d5071
-  data.tar.gz: 33f38588a1b795e323f76e909ef301905cacf9d77c0a418ac0809713960659b6
+  metadata.gz: 51da406ed4d19996c3802636ee0b1f9034b7c4505e746a11863f42e24dd7e81e
+  data.tar.gz: bc39ae4e01d39dd9468baac3ee370abf63de7f0313882d5bf84ea75850da6a01
 SHA512:
-  metadata.gz: 16a3b130741673e1ce4bfee15a5a4d8c45c66e5712e130a746f2d6be1e9940a1052a2c9195cce748831ca1652cc52255002226b31c0494516250b5359074c592
-  data.tar.gz: 920f8a21967bc69ecaf6072eec422e119e989415ddcd26d9e42e2d38779a35ddcfe58f5819cd3165c12799cf297dc5530da9a8d80ea6ae8c6a81c662d62c8fda
+  metadata.gz: 3363c4a1314e44fd3ebf0fc87943b49124b1c751e9e136357f7e8497b4d7b76b9f8e312831391bf85a6aa5b97d568937a44dbada7ae2deecbfe64be8a00e08da
+  data.tar.gz: 711f95a3e86978cf362589724ad9cbc4729811f5870cbce77b3b78c334f2100ae1039628368b931430e3f94fdd9acc72888a339fbc6a2f8102c9679fc39563a5

data/lib/hybrid_platforms_conductor/deployer.rb

@@ -18,8 +18,31 @@ module HybridPlatformsConductor
   # Gives ways to deploy on several nodes
   class Deployer
 
+    # Extend the Config DSL
+    module ConfigDSLExtension
+
+      # Integer: Timeout (in seconds) for packaging repositories
+      attr_reader :packaging_timeout_secs
+
+      # Mixin initializer
+      def init_deployer_config
+        @packaging_timeout_secs = 60
+      end
+
+      # Set the packaging timeout
+      #
+      # Parameters::
+      # * *packaging_timeout_secs* (Integer): The packaging timeout, in seconds
+      def packaging_timeout(packaging_timeout_secs)
+        @packaging_timeout_secs = packaging_timeout_secs
+      end
+
+    end
+
     include LoggerHelpers
 
+    Config.extend_config_dsl_with ConfigDSLExtension, :init_nodes_handler_config
+
     # Do we use why-run mode while deploying? [default = false]
     #   Boolean
     attr_accessor :use_why_run
@@ -135,9 +158,6 @@ module HybridPlatformsConductor
     # String: File used as a Futex for packaging
     PACKAGING_FUTEX_FILE = "#{Dir.tmpdir}/hpc_packaging"
 
-    # Integer: Timeout in seconds to get the packaging Futex
-    PACKAGING_FUTEX_TIMEOUT = 60
-
     # Deploy on a given list of nodes selectors.
     # The workflow is the following:
     # 1. Package the services to be deployed, considering the nodes, services and context (options, secrets, environment...)
@@ -176,7 +196,7 @@ module HybridPlatformsConductor
 
       # Package the deployment
       # Protect packaging by a Futex
-      Futex.new(PACKAGING_FUTEX_FILE, timeout: PACKAGING_FUTEX_TIMEOUT).open do
+      Futex.new(PACKAGING_FUTEX_FILE, timeout: @config.packaging_timeout_secs).open do
         section 'Packaging deployment' do
           @services_handler.package(
             services: services_to_deploy,

data/lib/hybrid_platforms_conductor/version.rb

@@ -1,5 +1,5 @@
 module HybridPlatformsConductor
 
-  VERSION = '32.3.6'
+  VERSION = '32.4.0'
 
 end

data/spec/hybrid_platforms_conductor_test/api/deployer/config_dsl_spec.rb

@@ -0,0 +1,15 @@
+describe HybridPlatformsConductor::Deployer do
+
+  context 'checking deployer specific config DSL' do
+
+    it 'declares a packaging timeout' do
+      with_repository do |repository|
+        with_platforms('packaging_timeout 666') do
+          expect(test_config.packaging_timeout_secs).to eq 666
+        end
+      end
+    end
+
+  end
+
+end

data/spec/hybrid_platforms_conductor_test/helpers/deployer_test_helpers.rb

@@ -1,3 +1,5 @@
+require 'timeout'
+
 module HybridPlatformsConductorTest
 
   module Helpers
@@ -76,6 +78,9 @@ module HybridPlatformsConductorTest
           #
           # Parameters::
           # * *nodes_info* (Hash): Node info to give the platform [default: 1 node having 1 service]
+          # * *expect_package* (Boolean): Should we expect packaging? [default: true]
+          # * *expect_prepare_for_deploy* (Boolean): Should we expect calls to prepare for deploy? [default: true]
+          # * *expect_connections_to_nodes* (Boolean): Should we expect connections to nodes? [default: true]
           # * *expect_default_actions* (Boolean): Should we expect default actions? [default: true]
           # * *expect_sudo* (Boolean): Do we expect sudo to be used in commands? [default: true]
           # * *expect_secrets* (Hash): Secrets to be expected during deployment [default: {}]
@@ -90,6 +95,9 @@ module HybridPlatformsConductorTest
           #     * *repository* (String): Path to the repository
           def with_platform_to_deploy(
             nodes_info: { nodes: { 'node' => { services: %w[service] } } },
+            expect_package: true,
+            expect_prepare_for_deploy: true,
+            expect_connections_to_nodes: true,
             expect_default_actions: true,
             expect_sudo: true,
             expect_secrets: {},
@@ -102,40 +110,52 @@ module HybridPlatformsConductorTest
           )
             platform_name = check_mode ? 'platform' : 'my_remote_platform'
             with_test_platform(nodes_info, !check_mode, additional_config) do |repository|
-              with_connections_mocked_on(nodes_info[:nodes].keys) do
-                # Mock the ServicesHandler accesses
-                expect_services_to_deploy = Hash[nodes_info[:nodes].map do |node, node_info|
-                  [node, node_info[:services]]
-                end]
-                unless check_mode
-                  expect(test_services_handler).to receive(:deploy_allowed?).with(
-                    services: expect_services_to_deploy,
-                    secrets: expect_secrets,
-                    local_environment: expect_local_environment
-                  ) do
-                    nil
-                  end
+              # Mock the ServicesHandler accesses
+              expect_services_to_deploy = Hash[nodes_info[:nodes].map do |node, node_info|
+                [node, node_info[:services]]
+              end]
+              unless check_mode
+                expect(test_services_handler).to receive(:deploy_allowed?).with(
+                  services: expect_services_to_deploy,
+                  secrets: expect_secrets,
+                  local_environment: expect_local_environment
+                ) do
+                  nil
                 end
+              end
+              if expect_package
                 expect(test_services_handler).to receive(:package).with(
                   services: expect_services_to_deploy,
                   secrets: expect_secrets,
                   local_environment: expect_local_environment
                 )
+              else
+                expect(test_services_handler).not_to receive(:package)
+              end
+              if expect_prepare_for_deploy
                 expect(test_services_handler).to receive(:prepare_for_deploy).with(
                   services: expect_services_to_deploy,
                   secrets: expect_secrets,
                   local_environment: expect_local_environment,
                   why_run: check_mode
                 )
-                expect_actions_executor_runs(expected_actions_for_deploy_on(
-                  services: expect_services_to_deploy,
-                  check_mode: check_mode,
-                  sudo: expect_sudo,
-                  additional_expected_actions: expect_additional_actions,
-                  expect_concurrent_actions: expect_concurrent_actions,
-                  expect_actions_timeout: expect_actions_timeout
-                )) if expect_default_actions
-                test_deployer.use_why_run = true if check_mode
+              else
+                expect(test_services_handler).not_to receive(:prepare_for_deploy)
+              end
+              test_deployer.use_why_run = true if check_mode
+              if expect_connections_to_nodes
+                with_connections_mocked_on(nodes_info[:nodes].keys) do
+                  expect_actions_executor_runs(expected_actions_for_deploy_on(
+                    services: expect_services_to_deploy,
+                    check_mode: check_mode,
+                    sudo: expect_sudo,
+                    additional_expected_actions: expect_additional_actions,
+                    expect_concurrent_actions: expect_concurrent_actions,
+                    expect_actions_timeout: expect_actions_timeout
+                  )) if expect_default_actions
+                  yield repository
+                end
+              else
                 yield repository
               end
             end
@@ -360,6 +380,31 @@ module HybridPlatformsConductorTest
             end
           end
 
+          it 'fails when packaging timeout has been reached while taking the futex' do
+            with_platform_to_deploy(
+                additional_config: 'packaging_timeout 1',
+                expect_package: false,
+                expect_prepare_for_deploy: false,
+                expect_connections_to_nodes: false
+            ) do
+              # Simulate another process taking the packaging futex
+              futex_file = HybridPlatformsConductor::Deployer.const_get(:PACKAGING_FUTEX_FILE)
+              Futex.new(futex_file).open do
+                # Expect the error to be raised within 2 seconds (as it should timeout after 1 second)
+                begin
+                  Timeout::timeout(2) {
+                    expect { test_deployer.deploy_on('node') }.to raise_error(
+                      Futex::CantLock,
+                      /can't get exclusive access to the file #{Regexp.escape(futex_file)} because of the lock at #{Regexp.escape(futex_file)}\.lock, after 1\.\d+s of waiting/
+                    )
+                  }
+                rescue Timeout::Error
+                  raise 'The packaging timeout (set to 1 seconds) did not fire within 2 seconds. Looks like it is not working properly.'
+                end
+              end
+            end
+          end
+
           context 'checking deployment retries' do
 
             # Prepare a platform ready to test deployments' retries on.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hybrid_platforms_conductor
 version: !ruby/object:Gem::Version
-  version: 32.3.6
+  version: 32.4.0
 platform: ruby
 authors:
 - Muriel Salvan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-04 00:00:00.000000000 Z
+date: 2021-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: range_operators
@@ -281,20 +281,20 @@ description: Provides a complete toolset to help DevOps maintain, deploy, monito
 email:
 - muriel@x-aeon.com
 executables:
-- run
-- last_deploys
-- dump_nodes_json
 - test
-- nodes_to_deploy
-- check-node
-- deploy
+- topograph
+- dump_nodes_json
 - free_veids
-- ssh_config
 - report
-- topograph
 - setup
-- free_ips
+- deploy
+- last_deploys
 - get_impacted_nodes
+- ssh_config
+- run
+- nodes_to_deploy
+- check-node
+- free_ips
 extensions: []
 extra_rdoc_files: []
 files:
@@ -435,6 +435,7 @@ files:
 - spec/hybrid_platforms_conductor_test/api/cmd_runner_spec.rb
 - spec/hybrid_platforms_conductor_test/api/config_spec.rb
 - spec/hybrid_platforms_conductor_test/api/deployer/check_spec.rb
+- spec/hybrid_platforms_conductor_test/api/deployer/config_dsl_spec.rb
 - spec/hybrid_platforms_conductor_test/api/deployer/deploy_spec.rb
 - spec/hybrid_platforms_conductor_test/api/deployer/parse_deploy_output_spec.rb
 - spec/hybrid_platforms_conductor_test/api/deployer/provisioner_spec.rb