hybrid_platforms_conductor 33.8.4 → 33.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b18c3901744a84b3c1c820a8bc8af074cecdc78d56b7802186d9d6751c5b78ed
-  data.tar.gz: ef312bf22ddcdd7473d3c606d665e3eec5760a842822b0fb36dedf7ce840fa6b
+  metadata.gz: d88a5c946d63351586ef1b77ec9840e13e84af48c210bc8dfd1004abc27f547d
+  data.tar.gz: 8d04e563077d81cc72d5c3dc883f0010205a3880a255c1fb229ff3ba11771b49
 SHA512:
-  metadata.gz: 543a74c57e08edde95103dff97af8c90360908e87e2d7be1c1c79a53dc85cb314f26b23b8591dabaeb88efb6415c2b3a5909ed8ca392a2dc0e3a61dabfb3b781
-  data.tar.gz: 87f5bb43a345cb9373d43211ffbea8e47c08de26a7256f0f2b51ff2660b6021bc251a448ba51006c34ca02c88d442d88c2d027d1b15638a7e2fb396c2336423f
+  metadata.gz: 211847acef3bff5d8e2e554a6262c783230989c3877b830cdbf4a3c5ff8a0fdb414669c891b9bf102f8adf26aed4000189df7565a1e33e93094ee384a577cbd1
+  data.tar.gz: 1faa911b27e3fdda61c605711de26598c6bac9a533519a4b2d583da479f1be9ea32265433d34cf9d8c6aaeee06d45e83b80e648c013ed2342df728a83f9bb6cf

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+# [v33.9.0](https://github.com/sweet-delights/hybrid-platforms-conductor/compare/v33.8.4...v33.9.0) (2021-08-24 13:15:44)
+
+## Global changes
+### Patches
+
+* [[Feature(platform_handler)] [#102] Add the name option when declaring platforms to set the platform name](https://github.com/sweet-delights/hybrid-platforms-conductor/commit/13ada7687f08b3f970521320e2b26ea42d9a6d7f)
+
+## Changes for platform_handler
+### Features
+
+* [[Feature(platform_handler)] [#102] Add the name option when declaring platforms to set the platform name](https://github.com/sweet-delights/hybrid-platforms-conductor/commit/13ada7687f08b3f970521320e2b26ea42d9a6d7f)
+
 # [v33.8.4](https://github.com/sweet-delights/hybrid-platforms-conductor/compare/v33.8.3...v33.8.4) (2021-08-20 15:45:41)
 
 ## Global changes

data/docs/config_dsl.md

@@ -28,19 +28,25 @@ This DSL can also be completed by plugins. Check [the plugins documentations](pl
 Declare a new platform of type `<platform_type>`, providing either a local path to it (using `path: '/path/to/files'`) or a git repository to it (using `git: 'git_url'`). The possible platform types are the names of the [`platform_handler` plugins](plugins.md#platform_handler).
 
 Git branches can also be specified using `branch: 'branch_name'`.
+
+The name of the platform (as used for example by the [`for_nodes`](#for_nodes) DSL) defaults to the base name of the directory in case of a local path, or the base name of the first remote in case of a git repository. It can be enforced to a given name using `name: 'platform_name'` (useful to avoid name conflicts and keep consistency with the rest of your configuration among the team).
+
 An optional code block taking the local repository path as parameter can also be specified to add configuration that is specific to this platform.
 
 Examples:
 ```ruby
-# Declare a platform of type Chef, located in a distant git repository
+# Declare a platform of type Chef, located in a distant git repository (its name will be my-chef-repo)
 chef_platform git: 'https://my-git.domain.com/project/my-chef-repo.git'
 
-# Declare a platform located in a local path
-chef_platform path: '/path/to/my-chef-repo'
+# Declare a platform located in a local path (its name will be my-other-chef-repo)
+chef_platform path: '/path/to/my-other-chef-repo'
+
+# Declare a platform located in a local path and forces its name (its name will be my-platform)
+chef_platform path: '/path/to/my-repo', name: 'my-platform'
 
 # Declare a platform from a git branch, and apply some configuration to it
 chef_platform(
-  git: 'https://my-git.domain.com/project/my-chef-repo.git',
+  git: 'https://my-git.domain.com/project/devops-chef-repo.git',
   branch: 'my-branch'
 ) do |path|
   # Here path will be a local path containing a checkout of the branch my-branch of the git repo.

data/lib/hybrid_platforms_conductor/hpc_plugins/platform_handler/serverless_chef.rb

@@ -47,24 +47,10 @@ module HybridPlatformsConductor
         end
         extend_config_dsl_with MyDSLExtension, :init_serverless_chef
 
-        # Constructor
-        #
-        # Parameters::
-        # * *platform_type* (Symbol): Platform type
-        # * *repository_path* (String): Repository path
-        # * *logger* (Logger): Logger to be used [default: Logger.new(STDOUT)]
-        # * *logger_stderr* (Logger): Logger to be used for stderr [default: Logger.new(STDERR)]
-        # * *config* (Config): Config to be used. [default: Config.new]
-        # * *cmd_runner* (CmdRunner): Command executor to be used. [default: CmdRunner.new]
-        def initialize(
-          platform_type,
-          repository_path,
-          logger: Logger.new($stdout),
-          logger_stderr: Logger.new($stderr),
-          config: Config.new,
-          cmd_runner: CmdRunner.new
-        )
-          super
+        # Initialize a new instance of this platform handler.
+        # [API] - This method is optional.
+        # [API] - @cmd_runner is accessible.
+        def init
           # Mutex for getting the full recipes tree
           @recipes_tree_mutex = Mutex.new
         end

data/lib/hybrid_platforms_conductor/platform_handler.rb

@@ -17,13 +17,13 @@ module HybridPlatformsConductor
       # Make sure we define automatically a helper for such a platform
       mixin = Module.new
       platform_type = subclass.name.split('::').last.gsub(/([a-z\d])([A-Z\d])/, '\1_\2').downcase.to_sym
-      mixin.define_method("#{platform_type}_platform".to_sym) do |path: nil, git: nil, branch: 'master', &platform_config_code|
+      mixin.define_method("#{platform_type}_platform".to_sym) do |path: nil, git: nil, branch: 'master', name: nil, &platform_config_code|
         repository_path =
           if !path.nil?
             path
           elsif !git.nil?
             # Clone in a local repository
-            local_repository_path = "#{@git_platforms_dir}/#{File.basename(git)[0..-File.extname(git).size - 1]}"
+            local_repository_path = "#{@git_platforms_dir}/#{name.nil? ? File.basename(git)[0..-File.extname(git).size - 1] : name}"
             unless File.exist?(local_repository_path)
               branch = "refs/heads/#{branch}" unless branch.include?('/')
               local_ref = "refs/remotes/origin/#{branch.split('/').last}"
@@ -37,8 +37,10 @@ module HybridPlatformsConductor
           else
             raise 'The platform has to be defined with either a path or a git URL'
           end
-        @platform_dirs[platform_type] = [] unless @platform_dirs.key?(platform_type)
-        @platform_dirs[platform_type] << repository_path
+        @platforms_info[platform_type] = {} unless @platforms_info.key?(platform_type)
+        raise "Platform repository path #{repository_path} is declared several times." if @platforms_info.values.any? { |known_platforms_info| known_platforms_info.key?(repository_path) }
+
+        @platforms_info[platform_type][repository_path] = name.nil? ? {} : { name: name }
         platform_config_code&.call(repository_path)
       end
       # Register this new mixin in the Config DSL
@@ -66,18 +68,21 @@ module HybridPlatformsConductor
     # * *logger_stderr* (Logger): Logger to be used for stderr [default: Logger.new(STDERR)]
     # * *config* (Config): Config to be used. [default: Config.new]
     # * *cmd_runner* (CmdRunner): Command executor to be used. [default: CmdRunner.new]
+    # * *name* (String or nil): Platform name, or nil for defaults (based on path or git remote) [default: nil]
     def initialize(
       platform_type,
       repository_path,
       logger: Logger.new($stdout),
       logger_stderr: Logger.new($stderr),
       config: Config.new,
-      cmd_runner: CmdRunner.new
+      cmd_runner: CmdRunner.new,
+      name: nil
     )
       super(logger: logger, logger_stderr: logger_stderr, config: config)
       @platform_type = platform_type
       @repository_path = repository_path
       @cmd_runner = cmd_runner
+      @name = name
       init if respond_to?(:init)
     end
 
@@ -142,7 +147,12 @@ module HybridPlatformsConductor
             git_status = git.status
             git_commit = git.log.first
             {
-              repo_name: git.remotes.empty? ? File.basename(@repository_path) : File.basename(git.remotes.first.url).gsub(/\.git$/, ''),
+              repo_name:
+                if @name.nil?
+                  git.remotes.empty? ? File.basename(@repository_path) : File.basename(git.remotes.first.url).gsub(/\.git$/, '')
+                else
+                  @name
+                end,
               commit: {
                 id: git_commit.sha,
                 ref: git_commit.name,
@@ -162,7 +172,7 @@ module HybridPlatformsConductor
             }
           else
             {
-              repo_name: File.basename(@repository_path)
+              repo_name: @name.nil? ? File.basename(@repository_path) : @name
             }
           end
       end

data/lib/hybrid_platforms_conductor/platforms_handler.rb

@@ -9,13 +9,14 @@ module HybridPlatformsConductor
     # Add some config DSL
     module ConfigDSLExtension
 
-      # List of platforms repository directories, per platform type
-      #   Hash<Symbol, Array<String> >
-      attr_reader :platform_dirs
+      # List of platforms repository directories and their associated info, per platform type
+      #   Hash<Symbol,        Hash<String,          Hash<Symbol,Object> > >
+      #   Hash<platform_type, Hash<repository_path, Hash<Symbol,Object> > >
+      attr_reader :platforms_info
 
       # Mixin initializer
       def init_platforms_handler
-        @platform_dirs = {}
+        @platforms_info = {}
         # Directory in which platforms are cloned
         @git_platforms_dir = "#{@hybrid_platforms_dir}/cloned_platforms"
       end
@@ -46,15 +47,16 @@ module HybridPlatformsConductor
       # Hash<Symbol, Array<PlatformHandler> >
       @platform_handlers = {}
       # Read all platforms from the config
-      @config.platform_dirs.each do |platform_type, repositories|
-        repositories.each do |repository_path|
+      @config.platforms_info.each do |platform_type, repositories_info|
+        repositories_info.each do |repository_path, repository_info|
           platform_handler = @platform_types[platform_type].new(
             platform_type,
             repository_path,
             logger: @logger,
             logger_stderr: @logger_stderr,
             config: @config,
-            cmd_runner: @cmd_runner
+            cmd_runner: @cmd_runner,
+            name: repository_info[:name]
           )
           # Check that this platform has unique name
           raise "Platform name #{platform_handler.name} is declared several times." if @platform_handlers.values.flatten.any? { |known_platform| known_platform.name == platform_handler.name }

data/lib/hybrid_platforms_conductor/version.rb

@@ -1,5 +1,5 @@
 module HybridPlatformsConductor
 
-  VERSION = '33.8.4'
+  VERSION = '33.9.0'
 
 end

data/spec/hybrid_platforms_conductor_test/api/nodes_handler/nodes_selectors_spec.rb

@@ -15,6 +15,10 @@ describe HybridPlatformsConductor::NodesHandler do
           },
           'platform2' => {
             nodes: { 'node4' => {}, 'node5' => { services: %w[service3 service1] }, 'node6' => {} }
+          },
+          'platform3' => {
+            nodes: { 'node7' => {} },
+            name: 'other_platform'
           }
         },
         &block
@@ -24,12 +28,13 @@ describe HybridPlatformsConductor::NodesHandler do
     # List all tests of nodes selectors, and the corresponding nodes list they should be resolved into
     {
       [] => [],
-      [{ all: true }] => %w[node1 node2 node3 node4 node5 node6],
+      [{ all: true }] => %w[node1 node2 node3 node4 node5 node6 node7],
       'node1' => %w[node1],
       '/node[12]/' => %w[node1 node2],
       [{ list: 'nodeslist1' }] => %w[node1 node3],
       [{ list: 'nodeslist2' }] => %w[node1 node2],
       [{ platform: 'platform2' }] => %w[node4 node5 node6],
+      [{ platform: 'other_platform' }] => %w[node7],
       [{ service: 'service1' }] => %w[node2 node5],
       ['/node[12]/', { service: 'service1' }] => %w[node1 node2 node5],
       [{ git_diff: { platform: 'platform2' } }] => %w[node4 node5 node6]
@@ -45,13 +50,13 @@ describe HybridPlatformsConductor::NodesHandler do
 
     it 'fails when selecting unknown nodes' do
       with_test_platform_for_nodes do
-        expect { test_nodes_handler.select_nodes('node1', 'node7') }.to raise_error(RuntimeError, 'Unknown nodes: node7')
+        expect { test_nodes_handler.select_nodes('node1', 'unknown_node') }.to raise_error(RuntimeError, 'Unknown nodes: unknown_node')
       end
     end
 
     it 'ignore unknown nodes when asked' do
       with_test_platform_for_nodes do
-        expect(test_nodes_handler.select_nodes(%w[node1 node7], ignore_unknowns: true).sort).to eq %w[node1 node7].sort
+        expect(test_nodes_handler.select_nodes(%w[node1 unknown_node], ignore_unknowns: true).sort).to eq %w[node1 unknown_node].sort
       end
     end
 
@@ -105,7 +110,7 @@ describe HybridPlatformsConductor::NodesHandler do
 
     it 'considers all nodes for en empty nodes selector stack' do
       with_test_platform_for_nodes do
-        expect(test_nodes_handler.select_from_nodes_selector_stack([]).sort).to eq %w[node1 node2 node3 node4 node5 node6].sort
+        expect(test_nodes_handler.select_from_nodes_selector_stack([]).sort).to eq %w[node1 node2 node3 node4 node5 node6 node7].sort
       end
     end
 

data/spec/hybrid_platforms_conductor_test/api/platforms_handler_spec.rb

@@ -2,22 +2,22 @@ describe HybridPlatformsConductor::PlatformsHandler do
 
   context 'when checking config specific DSL' do
 
-    it 'returns platform directories along with platform types' do
+    it 'returns platforms info' do
       with_test_platforms(
         {
           'platform1' => { platform_type: :test },
           'platform2' => { platform_type: :test_2 },
-          'platform3' => { platform_type: :test }
+          'platform3' => { platform_type: :test, name: 'other_platform' }
         }
       ) do |repositories|
-        expect(test_config.platform_dirs.keys.sort).to eq %i[test test_2].sort
-        expect(test_config.platform_dirs[:test].sort).to eq [
-          repositories['platform1'],
-          repositories['platform3']
-        ].sort
-        expect(test_config.platform_dirs[:test_2].sort).to eq [
-          repositories['platform2']
-        ].sort
+        expect(test_config.platforms_info.keys.sort).to eq %i[test test_2].sort
+        expect(test_config.platforms_info[:test]).to eq(
+          repositories['platform1'] => {},
+          repositories['platform3'] => { name: 'other_platform' }
+        )
+        expect(test_config.platforms_info[:test_2]).to eq(
+          repositories['platform2'] => {}
+        )
       end
     end
 
@@ -55,27 +55,57 @@ describe HybridPlatformsConductor::PlatformsHandler do
       {
         'platform1' => { platform_type: :test },
         'platform2' => { platform_type: :test_2 },
-        'platform3' => { platform_type: :test }
+        'platform3' => { platform_type: :test, name: 'other_platform' }
       }
     ) do
-      expect(test_platforms_handler.known_platforms.map(&:name).sort).to eq %w[platform1 platform2 platform3].sort
+      expect(test_platforms_handler.known_platforms.map(&:name).sort).to eq %w[platform1 platform2 other_platform].sort
     end
   end
 
   it 'fails if several platforms share the same name' do
     with_repository('platform1') do |repository|
+      FileUtils.mkdir_p "#{repository}/platform1"
       with_test_platforms(
         {
           'platform1' => { platform_type: :test },
           'platform2' => { platform_type: :test_2 }
         },
-        additional_config: "test_2_platform path: \'#{repository}\'"
+        additional_config: "test_2_platform path: \'#{repository}/platform1\'"
       ) do
         expect { test_platforms_handler.known_platforms }.to raise_error 'Platform name platform1 is declared several times.'
       end
     end
   end
 
+  it 'fails if several platforms share the same path' do
+    with_repository('platform1') do |repository|
+      with_test_platforms(
+        {
+          'platform1' => { platform_type: :test },
+          'platform2' => { platform_type: :test_2 }
+        },
+        additional_config: "test_2_platform path: \'#{repository}\', name: 'other_platform'"
+      ) do
+        expect { test_platforms_handler.known_platforms }.to raise_error "Platform repository path #{repository} is declared several times."
+      end
+    end
+  end
+
+  it 'can differentiate several platforms sharing the same path ending but with different explicit names' do
+    with_repository('platform1') do |repository|
+      FileUtils.mkdir_p "#{repository}/platform1"
+      with_test_platforms(
+        {
+          'platform1' => { platform_type: :test },
+          'platform2' => { platform_type: :test_2 }
+        },
+        additional_config: "test_platform path: \'#{repository}/platform1\', name: 'other_platform'"
+      ) do
+        expect(test_platforms_handler.known_platforms.map(&:name).sort).to eq %w[platform1 platform2 other_platform].sort
+      end
+    end
+  end
+
   it 'returns defined platforms filtered by platform type' do
     with_test_platforms(
       {

data/spec/hybrid_platforms_conductor_test/helpers/platforms_handler_helpers.rb

@@ -73,7 +73,9 @@ module HybridPlatformsConductorTest
       # Clean-up at the end.
       #
       # Parameters::
-      # * *platforms_info* (Hash<String,Object>): Platforms info for the test platform
+      # * *platforms_info* (Hash<String,Object>): Platforms info for the test platform:
+      #   * *platform_type* (Symbol): Name of the platform handler plugin for this platform
+      #   * *name* (String): Optional name to give the platform [optional]
       # * *as_git* (Boolean): Do we initialize those repositories as Git repositories? [default: false]
       # * *additional_config* (String): Additional config to be added [default: '']
       # * Proc: Code called with the environment ready
@@ -86,7 +88,7 @@ module HybridPlatformsConductorTest
             repositories.map do |platform, dir|
               platform_type = platforms_info[platform].key?(:platform_type) ? platforms_info[platform][:platform_type] : :test
               platform_types << platform_type unless platform_types.include?(platform_type)
-              "#{platform_type}_platform path: '#{dir}'"
+              "#{platform_type}_platform path: '#{dir}'#{platforms_info[platform].key?(:name) ? ", name: '#{platforms_info[platform][:name]}'" : ''}"
             end.join("\n") + "\n#{additional_config}"
           ) do
             register_platform_handlers(platform_types.map do |platform_type|

data/spec/hybrid_platforms_conductor_test/platform_handler_plugins/test.rb

@@ -200,10 +200,11 @@ module HybridPlatformsConductorTest
       # Result::
       # * Hash<Symbol, Object>: Platform info (check TestPlatformHandler#platforms_info to know about properties)
       def platform_info
+        _repo_base_name, found_platform_info = HybridPlatformsConductorTest::PlatformHandlerPlugins::Test.platforms_info.find { |search_repo_base_name, search_platform_info| (search_platform_info[:name] || search_repo_base_name) == name }
         {
           nodes: {},
           nodes_lists: {}
-        }.merge(HybridPlatformsConductorTest::PlatformHandlerPlugins::Test.platforms_info[name])
+        }.merge(found_platform_info)
       end
 
       # Return the node info of a given node

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hybrid_platforms_conductor
 version: !ruby/object:Gem::Version
-  version: 33.8.4
+  version: 33.9.0
 platform: ruby
 authors:
 - Muriel Salvan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-20 00:00:00.000000000 Z
+date: 2021-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: range_operators