hybrid_platforms_conductor 32.16.4 → 32.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d7b0039bca37d75c4f4893286370ca04ab72861b2c219b8199531dab80464fc
-  data.tar.gz: 4189e8181aad10e14ba60d325572ae85932718ff8d21506ad3374e07272b43f9
+  metadata.gz: f67bfa1f30b7c9dd212e403b33adf88b7955e8c8d5202cdb7d2ef4f9e35e87e5
+  data.tar.gz: e7f7da0c313fdfb841cacd570e030f678343f3a2fb7b3b31daa653c25318efa5
 SHA512:
-  metadata.gz: 38bc2f04b0f5c165ad61a3f402a9312b9d7bb596e7c828e19090e9f292c0fde28f6b4d00043e28d0bf840d4c842446d4899197fd379c43fa86bc1a461a5d1adc
-  data.tar.gz: c2188e0919f5c943905ff7384ab67c242169cd4182cdc61356b1be2c8bb7cc93a9e4fc88a9426fd2cb7a95b16ba9d477fbf253166ec8aa4a716f42fdd1e3e32b
+  metadata.gz: 12f526fc089214b09e21220d0a6bcf55083ee3c8b5dff2f23f3764a453de10c6b5a1f0695dc8b567888f903b0130180f56095bb5dff7f44c664dd57b272feabd
+  data.tar.gz: 86d6663b9af0159a551eae58c5803dc63099d8119472d137cb0d46ebee25156fd06e92f95dc6ef8fce948f3081cb0c9c3e015ae27dee781ba1d4e4aafa71f3e1

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+# [v32.17.0](https://github.com/sweet-delights/hybrid-platforms-conductor/compare/v32.16.4...v32.17.0) (2021-06-02 12:57:44)
+
+## Global changes
+### Patches
+
+* [[Feature(test_github_ci)] [#61] Add the github_ci test plugin to check for CI/CD of projects on Github](https://github.com/sweet-delights/hybrid-platforms-conductor/commit/a0082efe5c138ca88ca91a3c10f777f47fca5034)
+
+## Changes for test_github_ci
+### Features
+
+* [[Feature(test_github_ci)] [#61] Add the github_ci test plugin to check for CI/CD of projects on Github](https://github.com/sweet-delights/hybrid-platforms-conductor/commit/a0082efe5c138ca88ca91a3c10f777f47fca5034)
+
 # [v32.16.4](https://github.com/sweet-delights/hybrid-platforms-conductor/compare/v32.16.3...v32.16.4) (2021-06-01 13:25:19)
 
 ### Patches

data/docs/plugins.md

@@ -182,6 +182,7 @@ Plugins shipped by default:
 * [`executables`](plugins/test/executables.md)
 * [`file_system_hdfs`](plugins/test/file_system_hdfs.md)
 * [`file_system`](plugins/test/file_system.md)
+* [`github_ci`](plugins/test/github_ci.md)
 * [`hostname`](plugins/test/hostname.md)
 * [`idempotence`](plugins/test/idempotence.md)
 * [`ip`](plugins/test/ip.md)

data/docs/plugins/test/bitbucket_conf.md

@@ -12,7 +12,7 @@ Define a Bitbucket installation to be targeted.
 It takes the following parameters:
 * **url** (`String`): URL to the Bitbucket server
 * **project** (`String`): Project name from the Bitbucket server, storing repositories
-* **repos** (`Array<String>` or `Symbol`): List of repository names from this project, or :all for all [default: :all]
+* **repos** (`Array<String>` or `Symbol`): List of repository names from this project, or `:all` for all [default: `:all`]
 * **checks** (`Hash<Symbol, Object>`): Checks definition to be perform on those repositories [default: {}]
   * **branch_permissions** (`Array< Hash<Symbol, Object> >`): List of branch permissions to check [optional]
     * **type** (`String`): Type of branch permissions to check. Examples of values are 'fast-forward-only', 'no-deletes', 'pull-request-only'.

data/docs/plugins/test/github_ci.md

@@ -0,0 +1,48 @@
+# Test plugin: `github_ci`
+
+The `github_ci` test plugin checks that the `master` branch of Github repositories has a successful CI result from its [Github Actions](https://github.com/features/actions).
+
+## Config DSL extension
+
+### `github_repos`
+
+Define Github repositories to be targeted.
+
+It takes the following parameters:
+* **url** (`String`): URL to the Github API [default: `'https://api.github.com'`]
+* **user** (`String`): User or organization name, storing repositories
+* **repos** (`Array<String>` or `Symbol`): List of repository names from this project, or `:all` for all [default: `:all`]
+
+Example:
+```ruby
+github_repos(
+  # Github's user containing repositories
+  user: 'My-Github-User',
+  # List of repositories to check
+  repos: [
+    'my-platform-repo',
+    'my-chef-repo',
+    'my-hpc-plugins'
+  ]
+)
+```
+
+## Used credentials
+
+| Credential | Usage
+| --- | --- |
+| `github` | Used to connect to the Github API. Password should be the Github API token. |
+
+## Used Metadata
+
+| Metadata | Type | Usage
+| --- | --- | --- |
+
+## Used environment variables
+
+| Variable | Usage
+| --- | --- |
+
+## External tools dependencies
+
+None

data/docs/plugins/test/jenkins_ci_conf.md

@@ -12,7 +12,7 @@ It takes the following parameters:
 * **url** (`String`): URL to the Bitbucket server
 * **project** (`String`): Project name from the Bitbucket server, storing repositories
 * **jenkins_ci_url** (`String` or `nil`): Corresponding Jenkins CI URL, or nil if none.
-* **repos** (`Array<String>` or `Symbol`): List of repository names from this project, or :all for all [default: :all]
+* **repos** (`Array<String>` or `Symbol`): List of repository names from this project, or `:all` for all [default: `:all`]
 
 Example:
 ```ruby

data/docs/plugins/test/jenkins_ci_masters_ok.md

@@ -12,7 +12,7 @@ It takes the following parameters:
 * **url** (`String`): URL to the Bitbucket server
 * **project** (`String`): Project name from the Bitbucket server, storing repositories
 * **jenkins_ci_url** (`String` or `nil`): Corresponding Jenkins CI URL, or nil if none.
-* **repos** (`Array<String>` or `Symbol`): List of repository names from this project, or :all for all [default: :all]
+* **repos** (`Array<String>` or `Symbol`): List of repository names from this project, or `:all` for all [default: `:all`]
 
 Example:
 ```ruby

data/lib/hybrid_platforms_conductor/common_config_dsl/github.rb

@@ -0,0 +1,62 @@
+require 'octokit'
+require 'hybrid_platforms_conductor/credentials'
+
+module HybridPlatformsConductor
+
+  module CommonConfigDsl
+
+    module Github
+
+      # Initialize the DSL 
+      def init_github
+        # List of Github repositories definitions
+        # Array< Hash<Symbol, Object> >
+        # Each definition is just mapping the signature of #github_repos
+        @github_repos = []
+      end
+
+      # Register new Github repositories
+      #
+      # Parameters::
+      # * *url* (String): URL to the Github API [default: 'https://api.github.com']
+      # * *user* (String): User or organization name, storing repositories
+      # * *repos* (Array<String> or Symbol): List of repository names from this project, or :all for all [default: :all]
+      def github_repos(url: 'https://api.github.com', user:, repos: :all)
+        @github_repos << {
+          url: url,
+          user: user,
+          repos: repos
+        }
+      end
+
+      # 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
+        @github_repos.each do |repo_info|
+          Octokit.configure do |c|
+            c.api_endpoint = repo_info[:url]
+          end
+          Credentials.with_credentials_for(:github, @logger, @logger_stderr, url: 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
+
+end

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

@@ -0,0 +1,32 @@
+require 'hybrid_platforms_conductor/common_config_dsl/github'
+
+module HybridPlatformsConductor
+
+  module HpcPlugins
+
+    module Test
+
+      # Check that all repositories have a successful Github CI
+      class GithubCi < HybridPlatformsConductor::Test
+
+        self.extend_config_dsl_with CommonConfigDsl::Github, :init_github
+
+        # Check my_test_plugin.rb.sample documentation for signature details.
+        def test
+          @config.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' }.
+              sort_by { |run| run[:created_at] }.
+              last[:conclusion]
+            error "Last workflow status for repository #{repo_info[:slug]} is #{last_status}" unless last_status == 'success'
+          end
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/lib/hybrid_platforms_conductor/version.rb

@@ -1,5 +1,5 @@
 module HybridPlatformsConductor
 
-  VERSION = '32.16.4'
+  VERSION = '32.17.0'
 
 end

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

@@ -0,0 +1,72 @@
+describe HybridPlatformsConductor::TestsRunner do
+
+  context 'checking test plugins' do
+
+    context 'checking github_ci' do
+
+      it 'iterates over defined Github repos' do
+        with_repository do |repository|
+          platforms = <<~EOS
+            github_repos(
+              url: 'https://my_gh.my_domain.com',
+              user: 'GH-User1',
+              repos: [
+                'repo1',
+                'repo2'
+              ]
+            )
+            github_repos(
+              user: 'GH-User2',
+              repos: [
+                'repo3',
+                'repo4'
+              ]
+            )
+          EOS
+          with_platforms platforms do
+            repos = []
+            test_config.for_each_github_repo do |github, repo_info|
+              repos << {
+                github_url: github.api_endpoint,
+                repo_info: repo_info
+              }
+            end
+            expect(repos).to eq [
+              {
+                github_url: 'https://my_gh.my_domain.com/',
+                repo_info: {
+                  name: 'repo1',
+                  slug: 'GH-User1/repo1'
+                }
+              },
+              {
+                github_url: 'https://my_gh.my_domain.com/',
+                repo_info: {
+                  name: 'repo2',
+                  slug: 'GH-User1/repo2'
+                }
+              },
+              {
+                github_url: 'https://api.github.com/',
+                repo_info: {
+                  name: 'repo3',
+                  slug: 'GH-User2/repo3'
+                }
+              },
+              {
+                github_url: 'https://api.github.com/',
+                repo_info: {
+                  name: 'repo4',
+                  slug: 'GH-User2/repo4'
+                }
+              }
+            ]
+          end
+        end
+      end
+
+    end
+
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hybrid_platforms_conductor
 version: !ruby/object:Gem::Version
-  version: 32.16.4
+  version: 32.17.0
 platform: ruby
 authors:
 - Muriel Salvan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-01 00:00:00.000000000 Z
+date: 2021-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: range_operators
@@ -248,6 +248,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.21'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.21'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -345,6 +359,7 @@ extra_rdoc_files:
 - docs/plugins/provisioner/docker.md
 - docs/plugins/test/spectre.md
 - docs/plugins/test/bitbucket_conf.md
+- docs/plugins/test/github_ci.md
 - docs/plugins/test/vulnerabilities.md
 - docs/plugins/test/deploy_removes_root_access.md
 - docs/plugins/test/private_ips.md
@@ -538,6 +553,7 @@ files:
 - docs/plugins/test/executables.md
 - docs/plugins/test/file_system.md
 - docs/plugins/test/file_system_hdfs.md
+- docs/plugins/test/github_ci.md
 - docs/plugins/test/hostname.md
 - docs/plugins/test/idempotence.md
 - docs/plugins/test/ip.md
@@ -640,6 +656,7 @@ files:
 - lib/hybrid_platforms_conductor/common_config_dsl/bitbucket.rb
 - lib/hybrid_platforms_conductor/common_config_dsl/confluence.rb
 - lib/hybrid_platforms_conductor/common_config_dsl/file_system_tests.rb
+- lib/hybrid_platforms_conductor/common_config_dsl/github.rb
 - lib/hybrid_platforms_conductor/common_config_dsl/idempotence_tests.rb
 - lib/hybrid_platforms_conductor/config.rb
 - lib/hybrid_platforms_conductor/confluence.rb
@@ -690,6 +707,7 @@ files:
 - lib/hybrid_platforms_conductor/hpc_plugins/test/executables.rb
 - lib/hybrid_platforms_conductor/hpc_plugins/test/file_system.rb
 - lib/hybrid_platforms_conductor/hpc_plugins/test/file_system_hdfs.rb
+- lib/hybrid_platforms_conductor/hpc_plugins/test/github_ci.rb
 - lib/hybrid_platforms_conductor/hpc_plugins/test/hostname.rb
 - lib/hybrid_platforms_conductor/hpc_plugins/test/idempotence.rb
 - lib/hybrid_platforms_conductor/hpc_plugins/test/ip.rb
@@ -819,6 +837,7 @@ files:
 - spec/hybrid_platforms_conductor_test/api/tests_runner/platform_spec.rb
 - spec/hybrid_platforms_conductor_test/api/tests_runner/reports_spec.rb
 - spec/hybrid_platforms_conductor_test/api/tests_runner/test_plugins/bitbucket_conf_spec.rb
+- spec/hybrid_platforms_conductor_test/api/tests_runner/test_plugins/github_ci_spec.rb
 - spec/hybrid_platforms_conductor_test/api/tests_runner/test_reports_plugins/confluence_spec.rb
 - spec/hybrid_platforms_conductor_test/cmdb_plugins/test_cmdb.rb
 - spec/hybrid_platforms_conductor_test/cmdb_plugins/test_cmdb2.rb