hybrid_platforms_conductor 32.3.6

data/spec/hybrid_platforms_conductor_test/api/tests_runner/test_plugins/bitbucket_conf_spec.rb

@@ -0,0 +1,111 @@
+describe HybridPlatformsConductor::TestsRunner do
+
+  context 'checking test plugins' do
+
+    context 'checking bitbucket_conf' do
+
+      it 'iterates over defined Bitbucket repos' do
+        with_repository do |repository|
+          platforms = <<~EOS
+            bitbucket_repos(
+              url: 'https://my_bb1.my_domain.com',
+              project: 'PR1',
+              repos: [
+                'repo1',
+                'repo2'
+              ]
+            )
+            bitbucket_repos(
+              url: 'https://my_bb2.my_domain.com',
+              project: 'PR2',
+              repos: [
+                'repo3',
+                'repo4'
+              ],
+              jenkins_ci_url: 'https://my_jenkins.com',
+              checks: {
+                branch_permissions: [
+                  {
+                    type: 'fast-forward-only',
+                    branch: 'master',
+                    exempted_users: ['toto']
+                  }
+                ]
+              }
+            )
+          EOS
+          with_platforms platforms do
+            repos = []
+            test_config.for_each_bitbucket_repo do |bitbucket, repo_info|
+              repos << {
+                bitbucket_url: bitbucket.bitbucket_url,
+                repo_info: repo_info
+              }
+            end
+            expect(repos).to eq [
+              {
+                bitbucket_url: 'https://my_bb1.my_domain.com',
+                repo_info: {
+                  name: 'repo1',
+                  project: 'PR1',
+                  url: 'https://my_bb1.my_domain.com/scm/pr1/repo1.git',
+                  jenkins_ci_url: nil,
+                  checks: {}
+                }
+              },
+              {
+                bitbucket_url: 'https://my_bb1.my_domain.com',
+                repo_info: {
+                  name: 'repo2',
+                  project: 'PR1',
+                  url: 'https://my_bb1.my_domain.com/scm/pr1/repo2.git',
+                  jenkins_ci_url: nil,
+                  checks: {}
+                }
+              },
+              {
+                bitbucket_url: 'https://my_bb2.my_domain.com',
+                repo_info: {
+                  name: 'repo3',
+                  project: 'PR2',
+                  url: 'https://my_bb2.my_domain.com/scm/pr2/repo3.git',
+                  jenkins_ci_url: 'https://my_jenkins.com/job/repo3',
+                  checks: {
+                    branch_permissions: [
+                      {
+                        type: 'fast-forward-only',
+                        branch: 'master',
+                        exempted_users: ['toto']
+                      }
+                    ]
+                  }
+                }
+              },
+              {
+                bitbucket_url: 'https://my_bb2.my_domain.com',
+                repo_info: {
+                  name: 'repo4',
+                  project: 'PR2',
+                  url: 'https://my_bb2.my_domain.com/scm/pr2/repo4.git',
+                  jenkins_ci_url: 'https://my_jenkins.com/job/repo4',
+                  checks: {
+                    branch_permissions: [
+                      {
+                        type: 'fast-forward-only',
+                        branch: 'master',
+                        exempted_users: ['toto']
+                      }
+                    ]
+                  }
+                }
+              }
+            ]
+          end
+        end
+      end
+
+    end
+
+  end
+
+end

data/spec/hybrid_platforms_conductor_test/api/tests_runner/test_reports_plugins/confluence_spec.rb

@@ -0,0 +1,29 @@
+describe HybridPlatformsConductor::TestsRunner do
+
+  context 'checking test reports plugins' do
+
+    context 'checking confluence' do
+
+      it 'returns Confluence info' do
+        with_repository do |repository|
+          platforms = <<~EOS
+            confluence(
+              url: 'https://my_confluence.my_domain.com',
+              inventory_report_page_id: '123456'
+            )
+          EOS
+          with_platforms platforms do
+            expect(test_config.confluence_info).to eq(
+              url: 'https://my_confluence.my_domain.com',
+              inventory_report_page_id: '123456',
+              tests_report_page_id: nil
+            )
+          end
+        end
+      end
+
+    end
+
+  end
+
+end

data/spec/hybrid_platforms_conductor_test/cmdb_plugins/test_cmdb.rb

@@ -0,0 +1,166 @@
+module HybridPlatformsConductorTest
+
+  module CmdbPlugins
+
+    # CMDB plugin that can be piloted by test cases to test how NodesHandler is using such plugins
+    class TestCmdb < HybridPlatformsConductor::Cmdb
+
+      # Return the calls made to this plugin
+      # Array< [String,      Object, Object...] >
+      # Array< [method_name, arg1,   arg2...  ] >
+      attr_accessor :calls
+
+      # Return possible dependencies between properties.
+      # A property can need another property to be set before.
+      # For example an IP would need first to have the hostname to be known in order to be looked up.
+      # [API] - This method is optional
+      #
+      # Result::
+      # * Hash<Symbol, Symbol or Array<Symbol> >: The list of necessary properties (or single one) that should be set, per property name (:others can also be used here)
+      def property_dependencies
+        {
+          reversed_double: :double,
+          reversed_downcase: :downcase
+        }
+      end
+
+      # 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 a specific property for a given set of nodes.
+      # [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, Object>: The corresponding property, per required node.
+      #     Nodes for which the property can't be fetched can be ommitted.
+      def get_upcase(nodes, metadata)
+        record_call(:get_upcase, nodes, metadata)
+        Hash[nodes.map { |node| [node, node.upcase] }]
+      end
+
+      # Get a specific property for a given set of nodes.
+      # [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, Object>: The corresponding property, per required node.
+      #     Nodes for which the property can't be fetched can be ommitted.
+      def get_double(nodes, metadata)
+        record_call(:get_double, nodes, metadata)
+        Hash[nodes.map { |node| [node, node * 2] }]
+      end
+
+      # Get a specific property for a given set of nodes.
+      # [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, Object>: The corresponding property, per required node.
+      #     Nodes for which the property can't be fetched can be ommitted.
+      def get_reversed_double(nodes, metadata)
+        record_call(:get_reversed_double, nodes, metadata)
+        Hash[nodes.map { |node| [node, metadata[node][:double].reverse] }]
+      end
+
+      # Get a specific property for a given set of nodes.
+      # [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, Object>: The corresponding property, per required node.
+      #     Nodes for which the property can't be fetched can be ommitted.
+      def get_reversed_downcase(nodes, metadata)
+        record_call(:get_reversed_downcase, nodes, metadata)
+        Hash[nodes.map { |node| [node, metadata[node][:downcase] ? metadata[node][:downcase].reverse : 'UNKNOWN'] }]
+      end
+
+      # Get a specific property for a given set of nodes.
+      # [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, Object>: The corresponding property, per required node.
+      #     Nodes for which the property can't be fetched can be ommitted.
+      def get_nothing(nodes, metadata)
+        record_call(:get_nothing, nodes, metadata)
+        {}
+      end
+
+      # Get a specific property for a given set of nodes.
+      # [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, Object>: The corresponding property, per required node.
+      #     Nodes for which the property can't be fetched can be ommitted.
+      def get_same_comment(nodes, metadata)
+        record_call(:get_same_comment, nodes, metadata)
+        Hash[nodes.map { |node| [node, "Comment for #{node}"] }]
+      end
+
+      # Get a specific property for a given set of nodes.
+      # [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, Object>: The corresponding property, per required node.
+      #     Nodes for which the property can't be fetched can be ommitted.
+      def get_different_comment(nodes, metadata)
+        record_call(:get_different_comment, nodes, metadata)
+        Hash[nodes.map { |node| [node, 'Comment from test_cmdb'] }]
+      end
+
+      # Get a specific property for a given set of nodes.
+      # [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, Object>: The corresponding property, per required node.
+      #     Nodes for which the property can't be fetched can be ommitted.
+      def get_different_comment2(nodes, metadata)
+        record_call(:get_different_comment2, nodes, metadata)
+        Hash[nodes.map { |node| [node, 'Comment2 from test_cmdb'] }]
+      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/cmdb_plugins/test_cmdb2.rb

@@ -0,0 +1,93 @@
+module HybridPlatformsConductorTest
+
+  module CmdbPlugins
+
+    # CMDB plugin that can be piloted by test cases to test how NodesHandler is using such plugins
+    class TestCmdb2 < 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 a specific property for a given set of nodes.
+      # [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, Object>: The corresponding property, per required node.
+      #     Nodes for which the property can't be fetched can be ommitted.
+      def get_nothing(nodes, metadata)
+        record_call(:get_nothing, nodes, metadata)
+        # Here we return something to test that if the first one fails we have the second CMDB
+        Hash[nodes.map { |node| [node, "#{node} has nothing"] }]
+      end
+
+      # Get a specific property for a given set of nodes.
+      # [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, Object>: The corresponding property, per required node.
+      #     Nodes for which the property can't be fetched can be ommitted.
+      def get_same_comment(nodes, metadata)
+        record_call(:get_same_comment, nodes, metadata)
+        Hash[nodes.map { |node| [node, "Comment for #{node}"] }]
+      end
+
+      # Get a specific property for a given set of nodes.
+      # [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, Object>: The corresponding property, per required node.
+      #     Nodes for which the property can't be fetched can be ommitted.
+      def get_different_comment(nodes, metadata)
+        record_call(:get_different_comment, nodes, metadata)
+        Hash[nodes.map { |node| [node, 'Comment from test_cmdb2'] }]
+      end
+
+      # Get a specific property for a given set of nodes.
+      # [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, Object>: The corresponding property, per required node.
+      #     Nodes for which the property can't be fetched can be ommitted.
+      def get_different_comment2(nodes, metadata)
+        record_call(:get_different_comment2, nodes, metadata)
+        Hash[nodes.map { |node| [node, 'Comment2 from test_cmdb2'] }]
+      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/cmdb_plugins/test_cmdb_others.rb

@@ -0,0 +1,60 @@
+module HybridPlatformsConductorTest
+
+  module CmdbPlugins
+
+    # CMDB plugin that can be piloted by test cases to test how NodesHandler is using such plugins
+    class TestCmdbOthers < 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}_",
+              last_3: node[-3..-1],
+              nothing: "#{node} has another nothing"
+            }
+          ]
+        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