hybrid_platforms_conductor 33.3.0 → 33.4.0

data/lib/hybrid_platforms_conductor/deployer.rb

@@ -106,10 +106,10 @@ module HybridPlatformsConductor
 
     end
 
-    include LoggerHelpers
-
     Config.extend_config_dsl_with ConfigDSLExtension, :init_deployer_config
 
+    include LoggerHelpers
+
     # Do we use why-run mode while deploying? [default = false]
     #   Boolean
     attr_accessor :use_why_run

data/lib/hybrid_platforms_conductor/github.rb

@@ -0,0 +1,39 @@
+require 'octokit'
+require 'hybrid_platforms_conductor/credentials'
+
+module HybridPlatformsConductor
+
+  # Mixin used to access Github API
+  module Github
+
+    include Credentials
+
+    # Iterate over each Github repository
+    #
+    # Parameters::
+    # * Proc: Code called for each Github repository:
+    #   * Parameters::
+    #     * *github* (Octokit::Client): The client instance accessing the Github API
+    #     * *repo_info* (Hash<Symbol, Object>): The repository info:
+    #       * *name* (String): Repository name.
+    #       * *slug* (String): Repository slug.
+    def for_each_github_repo
+      @config.known_github_repos.each do |repo_info|
+        Octokit.configure do |c|
+          c.api_endpoint = repo_info[:url]
+        end
+        with_credentials_for(:github, resource: repo_info[:url]) do |_github_user, github_token|
+          client = Octokit::Client.new(access_token: github_token)
+          (repo_info[:repos] == :all ? client.repositories(repo_info[:user]).map { |repo| repo[:name] } : repo_info[:repos]).each do |name|
+            yield client, {
+              name: name,
+              slug: "#{repo_info[:user]}/#{name}"
+            }
+          end
+        end
+      end
+    end
+
+  end
+
+end

data/lib/hybrid_platforms_conductor/hpc_plugins/provisioner/proxmox.rb

@@ -263,6 +263,8 @@ module HybridPlatformsConductor
 
         private
 
+        include Credentials
+
         # Connect to the Proxmox API
         #
         # Parameters::
@@ -273,7 +275,7 @@ module HybridPlatformsConductor
           url = proxmox_test_info[:api_url]
           raise 'No Proxmox server defined' if url.nil?
 
-          Credentials.with_credentials_for(:proxmox, @logger, @logger_stderr, url: url) do |user, password|
+          with_credentials_for(:proxmox, resource: url) do |user, password|
             log_debug "[ #{@node}/#{@environment} ] - Connect to Proxmox #{url}"
             proxmox_logs = StringIO.new
             proxmox = ::Proxmox::Proxmox.new(
@@ -415,7 +417,7 @@ module HybridPlatformsConductor
             extra_files[config_file] = './proxmox/config'
             cmd << " --config ./proxmox/config/#{File.basename(config_file)}"
             stdout = nil
-            Credentials.with_credentials_for(:proxmox, @logger, @logger_stderr, url: proxmox_test_info[:api_url]) do |user, password|
+            with_credentials_for(:proxmox, resource: proxmox_test_info[:api_url]) do |user, password|
               # To avoid too fine concurrent accesses on the sync node file system, make sure all threads of our process wait for their turn to upload their files.
               # Otherwise there is a small probability that a directory scp makes previously copied files inaccessible for a short period of time.
               self.class.proxmox_waiter_files_mutex.synchronize do

data/lib/hybrid_platforms_conductor/hpc_plugins/report/confluence.rb

@@ -14,6 +14,8 @@ module HybridPlatformsConductor
 
         extend_config_dsl_with CommonConfigDsl::Confluence, :init_confluence
 
+        include HybridPlatformsConductor::Confluence
+
         # Give the list of supported locales by this report generator
         # [API] - This method is mandatory.
         #
@@ -34,7 +36,7 @@ module HybridPlatformsConductor
           if confluence_info
             if confluence_info[:inventory_report_page_id]
               @nodes = nodes
-              HybridPlatformsConductor::Confluence.with_confluence(confluence_info[:url], @logger, @logger_stderr) do |confluence|
+              with_confluence(confluence_info[:url]) do |confluence|
                 confluence.update_page(confluence_info[:inventory_report_page_id], render('confluence_inventory'))
               end
               out "Inventory report Confluence page updated. Please visit #{confluence_info[:url]}/pages/viewpage.action?pageId=#{confluence_info[:inventory_report_page_id]}"

data/lib/hybrid_platforms_conductor/hpc_plugins/secrets_reader/keepass.rb

@@ -17,6 +17,7 @@ module HybridPlatformsConductor
       class Keepass < HybridPlatformsConductor::SecretsReader
 
         include SafeMerge
+        include Credentials
 
         # Extend the Config DSL
         module ConfigDSLExtension
@@ -84,7 +85,7 @@ module HybridPlatformsConductor
             unless @secrets.key?(secret_id)
               raise 'Missing KPScript configuration. Please use use_kpscript_from to set it.' if @config.kpscript.nil?
 
-              Credentials.with_credentials_for(:keepass, @logger, @logger_stderr) do |_user, password|
+              with_credentials_for(:keepass, resource: keepass_secrets_info[:database]) do |_user, password|
                 Tempfile.create('hpc_keepass') do |xml_file|
                   key_file = ENV['hpc_key_file_for_keepass']
                   password_enc = ENV['hpc_password_enc_for_keepass']

data/lib/hybrid_platforms_conductor/hpc_plugins/secrets_reader/thycotic.rb

@@ -42,6 +42,8 @@ module HybridPlatformsConductor
 
         Config.extend_config_dsl_with ConfigDSLExtension, :init_thycotic_config
 
+        include HybridPlatformsConductor::Thycotic
+
         # Return secrets for a given service to be deployed on a node.
         # [API] - This method is mandatory
         # [API] - The following API components are accessible:
@@ -62,7 +64,7 @@ module HybridPlatformsConductor
           @nodes_handler.select_confs_for_node(node, @config.thycotic_secrets).each do |thycotic_secrets_info|
             server_id = "#{thycotic_secrets_info[:thycotic_url]}:#{thycotic_secrets_info[:secret_id]}"
             unless @secrets.key?(server_id)
-              HybridPlatformsConductor::Thycotic.with_thycotic(thycotic_secrets_info[:thycotic_url], @logger, @logger_stderr) do |thycotic|
+              with_thycotic(thycotic_secrets_info[:thycotic_url]) do |thycotic|
                 secret_file_item_id = thycotic.get_secret(thycotic_secrets_info[:secret_id]).dig(:secret, :items, :secret_item, :id)
                 raise "Unable to fetch secret file ID #{thycotic_secrets_info[:secret_id]} from #{thycotic_secrets_info[:thycotic_url]}" if secret_file_item_id.nil?
 

data/lib/hybrid_platforms_conductor/hpc_plugins/test/bitbucket_conf.rb

@@ -1,4 +1,5 @@
 require 'git'
+require 'hybrid_platforms_conductor/bitbucket'
 require 'hybrid_platforms_conductor/common_config_dsl/bitbucket'
 
 module HybridPlatformsConductor
@@ -12,9 +13,11 @@ module HybridPlatformsConductor
 
         extend_config_dsl_with CommonConfigDsl::Bitbucket, :init_bitbucket
 
+        include HybridPlatformsConductor::Bitbucket
+
         # Check my_test_plugin.rb.sample documentation for signature details.
         def test
-          @config.for_each_bitbucket_repo do |bitbucket, repo_info|
+          for_each_bitbucket_repo do |bitbucket, repo_info|
             # Test repo_info
             repo_id = "#{repo_info[:project]}/#{repo_info[:name]}"
             settings_pr = bitbucket.settings_pr(repo_info[:project], repo_info[:name])

data/lib/hybrid_platforms_conductor/hpc_plugins/test/github_ci.rb

@@ -1,3 +1,4 @@
+require 'hybrid_platforms_conductor/github'
 require 'hybrid_platforms_conductor/common_config_dsl/github'
 
 module HybridPlatformsConductor
@@ -11,9 +12,11 @@ module HybridPlatformsConductor
 
         extend_config_dsl_with CommonConfigDsl::Github, :init_github
 
+        include HybridPlatformsConductor::Github
+
         # Check my_test_plugin.rb.sample documentation for signature details.
         def test
-          @config.for_each_github_repo do |client, repo_info|
+          for_each_github_repo do |client, repo_info|
             log_debug "Checking CI for Github repository #{repo_info[:slug]}"
             last_status = client.repository_workflow_runs(repo_info[:slug])[:workflow_runs].
               select { |run| run[:head_branch] == 'master' }.

data/lib/hybrid_platforms_conductor/hpc_plugins/test/jenkins_ci_conf.rb

@@ -1,6 +1,7 @@
 require 'open-uri'
 require 'nokogiri'
 require 'hybrid_platforms_conductor/credentials'
+require 'hybrid_platforms_conductor/bitbucket'
 require 'hybrid_platforms_conductor/common_config_dsl/bitbucket'
 
 module HybridPlatformsConductor
@@ -14,13 +15,16 @@ module HybridPlatformsConductor
 
         extend_config_dsl_with CommonConfigDsl::Bitbucket, :init_bitbucket
 
+        include Credentials
+        include HybridPlatformsConductor::Bitbucket
+
         # Check my_test_plugin.rb.sample documentation for signature details.
         def test
-          @config.for_each_bitbucket_repo do |bitbucket, repo_info|
+          for_each_bitbucket_repo do |bitbucket, repo_info|
             if repo_info[:jenkins_ci_url].nil?
               error "Repository #{repo_info[:name]} does not have any Jenkins CI URL configured."
             else
-              Credentials.with_credentials_for(:jenkins_ci, @logger, @logger_stderr, url: repo_info[:jenkins_ci_url]) do |jenkins_user, jenkins_password|
+              with_credentials_for(:jenkins_ci, resource: repo_info[:jenkins_ci_url]) do |jenkins_user, jenkins_password|
                 # Get its config
                 doc = Nokogiri::XML(URI.parse("#{repo_info[:jenkins_ci_url]}/config.xml").open(http_basic_authentication: [jenkins_user, jenkins_password]).read)
                 # Check that this job builds the correct Bitbucket repository

data/lib/hybrid_platforms_conductor/hpc_plugins/test/jenkins_ci_masters_ok.rb

@@ -1,5 +1,6 @@
 require 'json'
 require 'hybrid_platforms_conductor/credentials'
+require 'hybrid_platforms_conductor/bitbucket'
 require 'hybrid_platforms_conductor/common_config_dsl/bitbucket'
 
 module HybridPlatformsConductor
@@ -13,6 +14,9 @@ module HybridPlatformsConductor
 
         extend_config_dsl_with CommonConfigDsl::Bitbucket, :init_bitbucket
 
+        include Credentials
+        include HybridPlatformsConductor::Bitbucket
+
         SUCCESS_STATUSES = [
           # Add nil as the status of a currently running job (which is always the case for hybrid-platforms) is null
           nil,
@@ -23,12 +27,12 @@ module HybridPlatformsConductor
 
         # Check my_test_plugin.rb.sample documentation for signature details.
         def test
-          @config.for_each_bitbucket_repo do |_bitbucket, repo_info|
+          for_each_bitbucket_repo do |_bitbucket, repo_info|
             if repo_info[:jenkins_ci_url].nil?
               error "Repository #{repo_info[:name]} does not have any Jenkins CI URL configured."
             else
               master_info_url = "#{repo_info[:jenkins_ci_url]}/job/master/api/json"
-              Credentials.with_credentials_for(:jenkins_ci, @logger, @logger_stderr, url: master_info_url) do |jenkins_user, jenkins_password|
+              with_credentials_for(:jenkins_ci, resource: master_info_url) do |jenkins_user, jenkins_password|
                 # Get the master branch info from the API
                 master_info = JSON.parse(URI.parse(master_info_url).open(http_basic_authentication: [jenkins_user, jenkins_password]).read)
                 # Get the last build's URL

data/lib/hybrid_platforms_conductor/hpc_plugins/test_report/confluence.rb

@@ -14,6 +14,8 @@ module HybridPlatformsConductor
 
         extend_config_dsl_with CommonConfigDsl::Confluence, :init_confluence
 
+        include HybridPlatformsConductor::Confluence
+
         # Maximum errors to be reported by item
         MAX_ERROR_ITEMS_DISPLAYED = 10
 
@@ -28,7 +30,7 @@ module HybridPlatformsConductor
           confluence_info = @config.confluence_info
           if confluence_info
             if confluence_info[:tests_report_page_id]
-              HybridPlatformsConductor::Confluence.with_confluence(confluence_info[:url], @logger, @logger_stderr) do |confluence|
+              with_confluence(confluence_info[:url]) do |confluence|
                 # Get previous percentages for the evolution
                 @previous_success_percentages = confluence.page_storage_format(confluence_info[:tests_report_page_id]).
                   at('h1:contains("Evolution")').

data/lib/hybrid_platforms_conductor/logger_helpers.rb

@@ -88,7 +88,13 @@ module HybridPlatformsConductor
       define_method("log_#{level}") do |message|
         (LEVELS_TO_STDERR.include?(level) ? @logger_stderr : @logger).send(
           level,
-          defined?(@log_component) ? @log_component : self.class.name.split('::').last
+          if defined?(@log_component)
+            @log_component
+          else
+            # Handle the case when the class is unnamed
+            class_name = self.class.name
+            class_name.nil? ? '<Unnamed class>' : class_name.split('::').last
+          end
         ) { message }
       end
     end

data/lib/hybrid_platforms_conductor/thycotic.rb

@@ -5,95 +5,100 @@ require 'hybrid_platforms_conductor/logger_helpers'
 
 module HybridPlatformsConductor
 
-  # Gives ways to query the Thycotic SOAP API at a given URL
-  class Thycotic
+  # Mixin giving ways to query the Thycotic SOAP API at a given URL
+  module Thycotic
 
-    include LoggerHelpers
+    include Credentials
 
     # Provide a Thycotic connector, and make sure the password is being cleaned when exiting.
     #
     # Parameters::
     # * *thycotic_url* (String): The Thycotic URL
-    # * *logger* (Logger): Logger to be used
-    # * *logger_stderr* (Logger): Logger to be used for stderr
     # * *domain* (String): Domain to use for authentication to Thycotic [default: ENV['hpc_domain_for_thycotic']]
     # * Proc: Code called with the Thyctotic instance.
-    #   * *thycotic* (Thyctotic): The Thyctotic instance to use.
-    def self.with_thycotic(thycotic_url, logger, logger_stderr, domain: ENV['hpc_domain_for_thycotic'])
-      Credentials.with_credentials_for(:thycotic, logger, logger_stderr, url: thycotic_url) do |thycotic_user, thycotic_password|
-        yield Thycotic.new(thycotic_url, thycotic_user, thycotic_password, domain: domain, logger: logger, logger_stderr: logger_stderr)
+    #   * *thycotic* (ThyctoticApi): The Thycotic instance to use.
+    def with_thycotic(thycotic_url, domain: ENV['hpc_domain_for_thycotic'])
+      with_credentials_for(:thycotic, resource: thycotic_url) do |thycotic_user, thycotic_password|
+        yield ThycoticApi.new(thycotic_url, thycotic_user, thycotic_password, domain: domain, logger: @logger, logger_stderr: @logger_stderr)
       end
     end
 
-    # Constructor
-    #
-    # Parameters::
-    # * *url* (String): URL of the Thycotic Secret Server
-    # * *user* (String): User name to be used to connect to Thycotic
-    # * *password* (String): Password to be used to connect to Thycotic
-    # * *domain* (String): Domain to use for authentication to Thycotic [default: ENV['hpc_domain_for_thycotic']]
-    # * *logger* (Logger): Logger to be used [default: Logger.new(STDOUT)]
-    # * *logger_stderr* (Logger): Logger to be used for stderr [default: Logger.new(STDERR)]
-    def initialize(
-      url,
-      user,
-      password,
-      domain: ENV['hpc_domain_for_thycotic'],
-      logger: Logger.new($stdout),
-      logger_stderr: Logger.new($stderr)
-    )
-      init_loggers(logger, logger_stderr)
-      # Get a token to this SOAP API
-      @client = Savon.client(
-        wsdl: "#{url}/webservices/SSWebservice.asmx?wsdl",
-        ssl_verify_mode: :none,
-        logger: @logger,
-        log: log_debug?
+    # Access to the Thycotic API
+    class ThycoticApi
+
+      include LoggerHelpers
+
+      # Constructor
+      #
+      # Parameters::
+      # * *url* (String): URL of the Thycotic Secret Server
+      # * *user* (String): User name to be used to connect to Thycotic
+      # * *password* (String): Password to be used to connect to Thycotic
+      # * *domain* (String): Domain to use for authentication to Thycotic [default: ENV['hpc_domain_for_thycotic']]
+      # * *logger* (Logger): Logger to be used [default: Logger.new(STDOUT)]
+      # * *logger_stderr* (Logger): Logger to be used for stderr [default: Logger.new(STDERR)]
+      def initialize(
+        url,
+        user,
+        password,
+        domain: ENV['hpc_domain_for_thycotic'],
+        logger: Logger.new($stdout),
+        logger_stderr: Logger.new($stderr)
       )
-      @token = @client.call(
-        :authenticate,
-        message: {
-          username: user,
-          password: password,
-          domain: domain
-        }
-      ).to_hash.dig(:authenticate_response, :authenticate_result, :token)
-      raise "Unable to get token from SOAP authentication to #{url}" if @token.nil?
-    end
+        init_loggers(logger, logger_stderr)
+        # Get a token to this SOAP API
+        @client = Savon.client(
+          wsdl: "#{url}/webservices/SSWebservice.asmx?wsdl",
+          ssl_verify_mode: :none,
+          logger: @logger,
+          log: log_debug?
+        )
+        @token = @client.call(
+          :authenticate,
+          message: {
+            username: user,
+            password: password,
+            domain: domain
+          }
+        ).to_hash.dig(:authenticate_response, :authenticate_result, :token)
+        raise "Unable to get token from SOAP authentication to #{url}" if @token.nil?
+      end
 
-    # Return secret corresponding to a given secret ID
-    #
-    # Parameters::
-    # * *secret_id* (Object): The secret ID
-    # Result::
-    # * Hash: The corresponding API result
-    def get_secret(secret_id)
-      @client.call(
-        :get_secret,
-        message: {
-          token: @token,
-          secretId: secret_id
-        }
-      ).to_hash.dig(:get_secret_response, :get_secret_result)
-    end
+      # Return secret corresponding to a given secret ID
+      #
+      # Parameters::
+      # * *secret_id* (Object): The secret ID
+      # Result::
+      # * Hash: The corresponding API result
+      def get_secret(secret_id)
+        @client.call(
+          :get_secret,
+          message: {
+            token: @token,
+            secretId: secret_id
+          }
+        ).to_hash.dig(:get_secret_response, :get_secret_result)
+      end
+
+      # Get a file attached to a given secret
+      #
+      # Parameters::
+      # * *secret_id* (Object): The secret ID
+      # * *secret_item_id* (Object): The secret item id
+      # Result::
+      # * String or nil: The file content, or nil if none
+      def download_file_attachment_by_item_id(secret_id, secret_item_id)
+        encoded_file = @client.call(
+          :download_file_attachment_by_item_id,
+          message: {
+            token: @token,
+            secretId: secret_id,
+            secretItemId: secret_item_id
+          }
+        ).to_hash.dig(:download_file_attachment_by_item_id_response, :download_file_attachment_by_item_id_result, :file_attachment)
+        encoded_file.nil? ? nil : Base64.decode64(encoded_file)
+      end
 
-    # Get a file attached to a given secret
-    #
-    # Parameters::
-    # * *secret_id* (Object): The secret ID
-    # * *secret_item_id* (Object): The secret item id
-    # Result::
-    # * String or nil: The file content, or nil if none
-    def download_file_attachment_by_item_id(secret_id, secret_item_id)
-      encoded_file = @client.call(
-        :download_file_attachment_by_item_id,
-        message: {
-          token: @token,
-          secretId: secret_id,
-          secretItemId: secret_item_id
-        }
-      ).to_hash.dig(:download_file_attachment_by_item_id_response, :download_file_attachment_by_item_id_result, :file_attachment)
-      encoded_file.nil? ? nil : Base64.decode64(encoded_file)
     end
 
   end

data/lib/hybrid_platforms_conductor/version.rb

@@ -1,5 +1,5 @@
 module HybridPlatformsConductor
 
-  VERSION = '33.3.0'
+  VERSION = '33.4.0'
 
 end