gitlab_support_readiness 1.0.12 → 1.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af0b51a6c4756ec281e1a95b11b4285679732fd2fef0477763ba91f311101ecf
-  data.tar.gz: b628588ccfa499ac5487b1e2e4162bb0a10645b3e0a93770e17b9cae3d7c2dfe
+  metadata.gz: 8ea6f1d80c924ce2c4c9f4cb929873f6244376d783f507b71f42c2abc39a4943
+  data.tar.gz: 1f1902a265ada7bac8aad9b3183f068fb80cf7e0f841e92b9ef408ccc7cdef30
 SHA512:
-  metadata.gz: 570055d78f7d5cedd8af65d927f771f6ff77a276a8a2cddc3ebab9d9ce6c0e04f11ae66241bfad730fc5a6cc9882348d1237e366bd412feb9cc544ef0b05081c
-  data.tar.gz: f77ba9593526b3375b39ea142e27775021ad7845debf03ba69ae26e642ce8b358516293a343743036ae38d13b956bc0d820134230cd20feeab3da14f3542a3af
+  metadata.gz: 6d8e2f831f94c90507f758dd744c4e8e84f4a7eb0041a763059b7a212d8a2e5a892a5f62ff692312a710c17b018ddc811be533dbdfb1c9a147779210e9327aac
+  data.tar.gz: 893eab1474c5eecdfcf18aa18cf6c6426e05e43e0ed8781f6dcf9107fecbc301277547f7b4aafe2f00bb02fa673135f72e0df0cdcd0df4c6ff03337236ab626d

data/lib/support_readiness/gitlab/jobs.rb

@@ -0,0 +1,189 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  # Defines the module GitLab
+  module GitLab
+    ##
+    # Defines the class Jobs within the module {Readiness::GitLab}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.13
+    # @todo List pipeline trigger jobs
+    # @todo Get job token’s job
+    # @todo Get GitLab agent by CI_JOB_TOKEN
+    # @todo Get a log file
+    # @todo Cancel a job
+    # @todo Retry a job
+    # @todo Erase a job
+    # @todo Run a job
+    class Jobs < Readiness::Client
+      attr_accessor :allow_failure, :archived, :artifacts, :artifacts_expire_at, :commit, :coverage, :created_at, :duration, :erased_at, :failure_reason, :finished_at, :id, :name, :pipeline, :project, :queued_duration, :ref, :runner, :runner_manager, :stage, :started_at, :status, :tag, :tag_list, :user, :web_url
+
+      ##
+      # Creates a new {Readiness::GitLab::Jobs} instance
+      #
+      # @author Jason Colyer
+      # @since 1.0.13
+      # @param object [Object] An instance of {Readiness::GitLab::Jobs}
+      # @example
+      #   require 'support_readiness'
+      #   Readiness::GitLab::Jobs.new
+      def initialize(object = {})
+        @allow_failure = object['allow_failure']
+        @archived = object['archived']
+        @artifacts = object['artifacts']
+        @artifacts_expire_at = object['artifacts_expire_at']
+        @commit = object['commit']
+        @coverage = object['coverage']
+        @created_at = object['created_at']
+        @duration = object['duration']
+        @erased_at = object['erased_at']
+        @failure_reason = object['failure_reason']
+        @finished_at = object['finished_at']
+        @id = object['id']
+        @name = object['name']
+        @pipeline = object['pipeline']
+        @project = object['project']
+        @queued_duration = object['queued_duration']
+        @ref = object['ref']
+        @runner = object['runner']
+        @runner_manager = object['runner_manager']
+        @stage = object['stage']
+        @started_at = object['started_at']
+        @status = object['status']
+        @tag = object['tag']
+        @tag_list = object['tag_list']
+        @user = object['user']
+        @web_url = object['web_url']
+      end
+
+      ##
+      # Lists all project jobs. Does not stop until it ends or the page limit is hit.
+      # This method can take a long time to run depending on the parameters used.
+      #
+      # @author Jason Colyer
+      # @since 1.0.13
+      # @param client [Object] An instance of {Readiness::GitLab::Client}
+      # @param project [Object] An instance of {Readiness::GitLab::Projects}
+      # @param limit [Integer] The number of pages to stop at. Using 0 means to list all.
+      # @param filters [Array] An array of filter Strings to use. Should be in the format of key=value
+      # @return [Array]
+      # @see https://docs.gitlab.com/ee/api/jobs.html#list-project-jobs GitLab API > Jobs > List project jobs
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::GitLab::Configuration.new
+      #   config.token = 'test123abc'
+      #   client = Readiness::GitLab::Client.new(config)
+      #   project = Readiness::GitLab::Projects.find!(client, 1083469)
+      #   jobs = Readiness::GitLab::Jobs.list_project(client, project, 2)
+      #   puts jobs.count
+      #   # => 200
+      def list_project(client, project, limit = 0, filters = [])
+        array = []
+        page = 1
+        loop do
+          response = client.connection.get "projects/#{project.id}/jobs?per_page=100&page=#{page}&#{to_param_string(filters)}"
+          handle_request_error(0, 'GitLab', response.status) unless response.status == 200
+          body = Oj.load(response.body)
+          array += body.map { |p| Jobs.new(p) }
+          break if body.count < 100
+          break if limit != 0 && array.count >= (limit * 100)
+
+          page += 1
+        end
+        array
+      end
+
+      ##
+      # Lists all pipeline jobs. Does not stop until it ends or the page limit is hit.
+      # This method can take a long time to run depending on the parameters used.
+      #
+      # @author Jason Colyer
+      # @since 1.0.13
+      # @param client [Object] An instance of {Readiness::GitLab::Client}
+      # @param pipeline [Object] An instance of {Readiness::GitLab::Pipelines}
+      # @param limit [Integer] The number of pages to stop at. Using 0 means to list all.
+      # @param filters [Array] An array of filter Strings to use. Should be in the format of key=value
+      # @return [Array]
+      # @see https://docs.gitlab.com/ee/api/jobs.html#list-pipeline-jobs GitLab API > Jobs > List pipeline jobs
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::GitLab::Configuration.new
+      #   config.token = 'test123abc'
+      #   client = Readiness::GitLab::Client.new(config)
+      #   project = Readiness::GitLab::Projects.find!(client, 1083469)
+      #   pipelines = Readiness::GitLab::Pipelines.list(client, project, 2, ["name=Check System", "status=failed"])
+      #   jobs = Readiness::GitLab::Jobs.list_pipeline(client, pipeline, 1)
+      #   puts jobs.count
+      #   # => 100
+      def list_pipeline(client, pipeline, limit = 0, filters = [])
+        array = []
+        page = 1
+        loop do
+          response = client.connection.get "projects/#{pipeline.project_id}/pipelines/#{pipeline.iid}/jobs?per_page=100&page=#{page}&#{to_param_string(filters)}"
+          handle_request_error(0, 'GitLab', response.status) unless response.status == 200
+          body = Oj.load(response.body)
+          array += body.map { |p| Jobs.new(p) }
+          break if body.count < 100
+          break if limit != 0 && array.count >= (limit * 100)
+
+          page += 1
+        end
+        array
+      end
+
+      ##
+      # Locates a project job within GitLab. This will not exit on error (except Authentication errors)
+      #
+      # @author Jason Colyer
+      # @since 1.0.13
+      # @param client [Object] An instance of {Readiness::GitLab::Client}
+      # @param project [Object] An instance of {Readiness::GitLab::Projects}
+      # @param jid [Integer] The job IID to find
+      # @return [Hash]
+      # @see https://docs.gitlab.com/ee/api/jobs.html#get-a-single-job GitLab API > Jobs > get a sngle job
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::GitLab::Configuration.new
+      #   config.token = 'test123abc'
+      #   client = Readiness::GitLab::Client.new(config)
+      #   project = Readiness::GitLab::Projects.find!(client, 1083469)
+      #   job = Readiness::GitLab::Jobs.find(client, project, 5)
+      #   puts job.status
+      #   # => "failed"
+      def self.find(client, project, jid)
+        response = client.connection.get "projects/#{project.id}/jobs/#{jid}"
+        handle_request_error(0, 'GitLab', response.status,  { action: 'get', id: jid }) unless response.status == 200
+        return Jobs.new(Oj.load(response.body)) if response.status == 200
+
+        Oj.load(response.body)
+      end
+
+      ##
+      # Locates a project job within GitLab. This will not exit on error (except Authentication errors)
+      #
+      # @author Jason Colyer
+      # @since 1.0.13
+      # @param client [Object] An instance of {Readiness::GitLab::Client}
+      # @param project [Object] An instance of {Readiness::GitLab::Projects}
+      # @param jid [Integer] The job IID to find
+      # @return [Object] An instance of {Readiness::GitLab::Jobs
+      # @see https://docs.gitlab.com/ee/api/jobs.html#get-a-single-job GitLab API > Jobs > get a sngle job
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::GitLab::Configuration.new
+      #   config.token = 'test123abc'
+      #   client = Readiness::GitLab::Client.new(config)
+      #   project = Readiness::GitLab::Projects.find!(client, 1083469)
+      #   job = Readiness::GitLab::Jobs.find!(client, project, 5)
+      #   puts job.status
+      #   # => "failed"
+      def self.find(client, project, jid)
+        response = client.connection.get "projects/#{project.id}/jobs/#{jid}"
+        handle_request_error(1, 'GitLab', response.status, { action: 'Find job', id: jid }) unless response.status == 200
+        Jobs.new(Oj.load(response.body))
+      end
+    end
+  end
+end

data/lib/support_readiness/gitlab/pipelines.rb

@@ -0,0 +1,191 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  # Defines the module GitLab
+  module GitLab
+    ##
+    # Defines the class Pipelines within the module {Readiness::GitLab}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.13
+    # @todo Get a pipeline’s test report
+    # @todo Get a pipeline’s test report summary
+    # @todo Create a new pipeline
+    # @todo Retry jobs in a pipeline
+    # @todo Cancel a pipeline's jobs
+    # @todo Delete a pipeline
+    # @todo Update pipeline metadata
+    class Pipelines < Readiness::Client
+      attr_accessor :created_at, :id, :iid, :name, :project_id, :ref, :sha, :source, :status, :updated_at, :web_url
+
+      ##
+      # Creates a new {Readiness::GitLab::Pipelines} instance
+      #
+      # @author Jason Colyer
+      # @since 1.0.13
+      # @param object [Object] An instance of {Readiness::GitLab::Pipelines}
+      # @example
+      #   require 'support_readiness'
+      #   Readiness::GitLab::Pipelines.new
+      def initialize(object = {})
+        @created_at = object['created_at']
+        @id = object['id']
+        @iid = object['iid']
+        @name = object['name']
+        @project_id = object['project_id']
+        @ref = object['ref']
+        @sha = object['sha']
+        @source = object['source']
+        @status = object['status']
+        @updated_at = object['updated_at']
+        @web_url = object['web_url']
+      end
+
+      ##
+      # Lists all pipelines for an object. Does not stop until it ends or the page limit is hit.
+      # This method can take a long time to run depending on the parameters used.
+      #
+      # @author Jason Colyer
+      # @since 1.0.13
+      # @param client [Object] An instance of {Readiness::GitLab::Client}
+      # @param project [Object] An instance of {Readiness::GitLab::Projects}
+      # @param limit [Integer] The number of pages to stop at. Using 0 means to list all.
+      # @param filters [Array] An array of filter Strings to use. Should be in the format of key=value
+      # @return [Array]
+      # @see https://docs.gitlab.com/ee/api/pipelines.html#list-project-pipelines GitLab API > Pipelines > List project pipelines
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::GitLab::Configuration.new
+      #   config.token = 'test123abc'
+      #   client = Readiness::GitLab::Client.new(config)
+      #   project = Readiness::GitLab::Projects.find!(client, 1083469)
+      #   pipelines = Readiness::GitLab::Pipelines.list(client, project, 2, ["name=Check System", "status=failed"])
+      #   puts pipelines.first.web_url
+      #   # => "https://gitlab.com/gitlab-com/support/support-team-meta/-/pipelines/2"
+      def self.list(client, project, limit = 0, filters = [])
+        array = []
+        page = 1
+        loop do
+          response = client.connection.get "projects/#{project.id}/pipelines?per_page=100&page=#{page}&#{to_param_string(filters)}"
+          handle_request_error(0, 'GitLab', response.status) unless response.status == 200
+          body = Oj.load(response.body)
+          array += body.map { |p| Pipelines.new(p) }
+          break if body.count < 100
+          break if limit != 0 && array.count >= (limit * 100)
+
+          page += 1
+        end
+        array
+      end
+
+      ##
+      # Locates a project pipeline within GitLab. This will not exit on error (except Authentication errors)
+      #
+      # @author Jason Colyer
+      # @since 1.0.13
+      # @param client [Object] An instance of {Readiness::GitLab::Client}
+      # @param project [Object] An instance of {Readiness::GitLab::Projects}
+      # @param pid [Integer] The pipeline IID to find
+      # @return [Hash]
+      # @see https://docs.gitlab.com/ee/api/pipelines.html#get-a-single-pipeline GitLab API > Pipelines > Get a single pipeline
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::GitLab::Configuration.new
+      #   config.token = 'test123abc'
+      #   client = Readiness::GitLab::Client.new(config)
+      #   project = Readiness::GitLab::Projects.find!(client, 1083469)
+      #   pipeline = Readiness::GitLab::Pipelines.find(client, project, 5)
+      #   puts pipeline.web_url
+      #   # => "https://gitlab.com/gitlab-com/support/support-team-meta/-/pipelines/5"
+      def self.find(client, project, pid)
+        response = client.connection.get "projects/#{project.id}/pipelines/#{pid}"
+        handle_request_error(0, 'GitLab', response.status,  { action: 'get', id: pid }) unless response.status == 200
+        return Pipelines.new(Oj.load(response.body)) if response.status == 200
+
+        Oj.load(response.body)
+      end
+
+      ##
+      # Locates a project pipeline within GitLab. This will exit on error
+      #
+      # @author Jason Colyer
+      # @since 1.0.13
+      # @param client [Object] An instance of {Readiness::GitLab::Client}
+      # @param project [Object] An instance of {Readiness::GitLab::Projects}
+      # @param pid [Integer] The pipeline IID to find
+      # @return [Object] An instance of {Readiness::GitLab::Pipelines}
+      # @see https://docs.gitlab.com/ee/api/pipelines.html#get-a-single-pipeline GitLab API > Pipelines > Get a single pipeline
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::GitLab::Configuration.new
+      #   config.token = 'test123abc'
+      #   client = Readiness::GitLab::Client.new(config)
+      #   project = Readiness::GitLab::Projects.find!(client, 1083469)
+      #   pipeline = Readiness::GitLab::Pipelines.find!(client, project, 5)
+      #   puts pipeline.web_url
+      #   # => "https://gitlab.com/gitlab-com/support/support-team-meta/-/pipelines/5"
+      def self.find!(client, project, pid)
+        response = client.connection.get "projects/#{project.id}/pipelines/#{pid}"
+        handle_request_error(1, 'GitLab', response.status, { action: 'Find pipeline', id: pid }) unless response.status == 200
+        Pipelines.new(Oj.load(response.body))
+      end
+
+      ##
+      # Gets the variables for a pipeline.
+      #
+      # @author Jason Colyer
+      # @since 1.0.13
+      # @param client [Object] An instance of {Readiness::GitLab::Client}
+      # @param pipeline [Object] An instance of {Readiness::GitLab::Pipelines}
+      # @return [Hash]
+      # @see https://docs.gitlab.com/ee/api/pipelines.html#get-variables-of-a-pipeline GitLab API > Pipelines > Get variables of a pipeline
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::GitLab::Configuration.new
+      #   config.token = 'test123abc'
+      #   client = Readiness::GitLab::Client.new(config)
+      #   project = Readiness::GitLab::Projects.find!(client, 1083469)
+      #   pipeline = Readiness::GitLab::Pipelines.find!(client, project, 5)
+      #   variables = Readiness::GitLab::Pipelines.find!(client, pipeline)
+      #   pp variables
+      #   # => [
+      #     {
+      #       "key": "NAME",
+      #       "variable_type": "env_var",
+      #       "value": "Jason"
+      #     }
+      #   ]
+      def self.variables(client, pipeline)
+        response = client.connection.get "projects/#{pipeline.project_id}/pipleines/#{pipeline.iid}/variables"
+        handle_request_error(0, 'GitLab', response.status,  { action: 'get', id: pid }) unless response.status == 200
+        Oj.load(response.body)
+      end
+
+      ##
+      # Lists all pipeline jobs. This is a wrapper of {Jobs#list_pipeline}
+      #
+      # @author Jason Colyer
+      # @since 1.0.13
+      # @param client [Object] An instance of {Readiness::GitLab::Client}
+      # @param pipeline [Object] An instance of {Readiness::GitLab::Pieplines}
+      # @param limit [Integer] The number of pages to stop at. Using 0 means to list all.
+      # @param filters [Array] An array of filter Strings to use. Should be in the format of key=value
+      # @return [Array]
+      # @see https://docs.gitlab.com/ee/api/jobs.html#list-pipeline-jobs GitLab API > Jobs > List pipeline jobs
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::GitLab::Configuration.new
+      #   config.token = 'test123abc'
+      #   client = Readiness::GitLab::Client.new(config)
+      #   project = Readiness::GitLab::Projects.find!(client, 1083469)
+      #   pipeline = Readiness::GitLab::Pipelines.find!(client, project, 2)
+      #   jobs = Readiness::GitLab::Pipelines.jobs(client, pipeline, 2)
+      #   puts jobs.count
+      #   # => 187
+      def self.jobs(client, pipeline, limit = 0, filters = [])
+        Jobs.list_pipeline(client, pipeline, limit, filters)
+      end
+    end
+  end
+end

data/lib/support_readiness/gitlab/projects.rb

@@ -540,6 +540,55 @@ module Readiness
         end
         array
       end
+
+      ##
+      # Lists all pipelines for an object. This is a wrapper of {Pipelines#list}
+      #
+      # @author Jason Colyer
+      # @since 1.0.13
+      # @param client [Object] An instance of {Readiness::GitLab::Client}
+      # @param project [Object] An instance of {Readiness::GitLab::Projects}
+      # @param limit [Integer] The number of pages to stop at. Using 0 means to list all.
+      # @param filters [Array] An array of filter Strings to use. Should be in the format of key=value
+      # @return [Array]
+      # @see https://docs.gitlab.com/ee/api/pipelines.html#list-project-pipelines GitLab API > Pipelines > List project pipelines
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::GitLab::Configuration.new
+      #   config.token = 'test123abc'
+      #   client = Readiness::GitLab::Client.new(config)
+      #   project = Readiness::GitLab::Projects.find!(client, 1083469)
+      #   pipelines = Readiness::GitLab::Projects.pipelines(client, project, 2, ["name=Check System", "status=failed"])
+      #   puts pipelines.first.web_url
+      #   # => "https://gitlab.com/gitlab-com/support/support-team-meta/-/pipelines/2"
+      def self.pipelines(client, project, limit = 0, filters = [])
+        Pipelines.list(client, project, limit, filters)
+      end
+
+      ##
+      # Lists all project jobs. This is a wrapper of {Jobs#list_project}
+      #
+      # @author Jason Colyer
+      # @since 1.0.13
+      # @param client [Object] An instance of {Readiness::GitLab::Client}
+      # @param project [Object] An instance of {Readiness::GitLab::Projects}
+      # @param limit [Integer] The number of pages to stop at. Using 0 means to list all.
+      # @param filters [Array] An array of filter Strings to use. Should be in the format of key=value
+      # @return [Array]
+      # @see https://docs.gitlab.com/ee/api/jobs.html#list-project-jobs GitLab API > Jobs > List project jobs
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::GitLab::Configuration.new
+      #   config.token = 'test123abc'
+      #   client = Readiness::GitLab::Client.new(config)
+      #   project = Readiness::GitLab::Projects.find!(client, 1083469)
+      #   pipeline = Readiness::GitLab::Pipelines.find!(client, project, 2)
+      #   jobs = Readiness::GitLab::Pipelines.jobs(client, pipeline, 2)
+      #   puts jobs.count
+      #   # => 187
+      def self.jobs(client, project, limit = 0, filters = [])
+        Jobs.list_project(client, project, limit, filters)
+      end
     end
   end
 end

data/lib/support_readiness/gitlab.rb

@@ -11,9 +11,11 @@ module Readiness
     require "#{__dir__}/gitlab/configuration"
     require "#{__dir__}/gitlab/groups"
     require "#{__dir__}/gitlab/issues"
+    require "#{__dir__}/gitlab/jobs"
     require "#{__dir__}/gitlab/markdown"
     require "#{__dir__}/gitlab/merge_requests"
     require "#{__dir__}/gitlab/namespaces"
+    require "#{__dir__}/gitlab/pipelines"
     require "#{__dir__}/gitlab/projects"
     require "#{__dir__}/gitlab/repositories"
     require "#{__dir__}/gitlab/users"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab_support_readiness
 version: !ruby/object:Gem::Version
-  version: 1.0.12
+  version: 1.0.13
 platform: ruby
 authors:
 - Jason Colyer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-10-10 00:00:00.000000000 Z
+date: 2024-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -246,9 +246,11 @@ files:
 - lib/support_readiness/gitlab/configuration.rb
 - lib/support_readiness/gitlab/groups.rb
 - lib/support_readiness/gitlab/issues.rb
+- lib/support_readiness/gitlab/jobs.rb
 - lib/support_readiness/gitlab/markdown.rb
 - lib/support_readiness/gitlab/merge_requests.rb
 - lib/support_readiness/gitlab/namespaces.rb
+- lib/support_readiness/gitlab/pipelines.rb
 - lib/support_readiness/gitlab/projects.rb
 - lib/support_readiness/gitlab/repositories.rb
 - lib/support_readiness/gitlab/users.rb