automate_soup 0.1.0

data/lib/automate_soup.rb

@@ -0,0 +1,264 @@
+require 'automate_soup/api'
+require 'automate_soup/credentials'
+require 'automate_soup/rest'
+require 'automate_soup/stage'
+require 'automate_soup/change'
+require 'automate_soup/version'
+require 'ostruct'
+
+##
+# Top level module
+#
+module AutomateSoup
+  class << self
+    attr_accessor :url, :credentials, :api, :enterprise, :organization, :project, :pipeline
+
+    ##
+    # Setup Automate Soup client.
+    #
+    # @option url [String] The Chef Automate URL.
+    # @option username [String] The Chef Automate username.
+    # @option token [String] The Chef Automate user token.
+    # @option password [String] The Chef Automate user password.
+    #
+    def setup(
+      url: nil,
+      username: nil,
+      token: nil,
+      password: nil,
+      enterprise: 'default',
+      organization: nil,
+      project: nil,
+      pipeline: nil
+    )
+      @url = url
+      @credentials = if token
+                       token_credentials(username, token)
+                     else
+                       password_credentials(username, password)
+                     end
+      @api = AutomateSoup::API.new(self)
+      @enterprise = enterprise
+      @organization = organization
+      @project = project
+      @pipeline = pipeline
+      self
+    end
+
+    ##
+    # Check the status of Automate
+    #
+    def status
+      o = @api.status
+      OpenStruct.new o
+    end
+
+    ##
+    # Fetch all organizations under an enterprise
+    #
+    def orgs(enterprise = 'default')
+      @api.orgs enterprise
+    end
+
+    ##
+    # Fetch all projects under an enterprise, organization pair
+    #
+    def projects(enterprise: 'default', organization: nil)
+      @api.projects(enterprise: enterprise, organization: organization)
+    end
+
+    ##
+    # Fetch all pipelines of a project under an enterprise, organization pair
+    #
+    def pipelines(enterprise: 'default', organization: nil, project: nil)
+      @api.pipelines(enterprise: enterprise, organization: organization, project: project)
+    end
+
+    ##
+    # Fetch a pipeline of a project under an enterprise, organization pair.
+    #
+    def pipeline(enterprise: 'default', organization: nil, project: nil, pipeline: nil)
+      arr = []
+      @api.pipeline(enterprise: enterprise, organization: organization, project: project, pipeline: pipeline).each do |o|
+        arr << OpenStruct.new(o)
+      end
+      arr
+    end
+
+    ##
+    # Filters out the topics from the pipelines changes .
+    #
+    # @option enterprise [String] the enterprise to fetch org from, defaults to
+    # default.
+    # @option organization [String] the organization to fetch from.
+    # @option project [String] the project to fetch from.
+    # @option pipeline [String] the pipeline to fetch from.
+    #
+    def pipeline_topics(enterprise: 'default', organization: nil, project: nil, pipeline: nil)
+      self.pipeline(
+        enterprise: enterprise,
+        organization: organization,
+        project: project,
+        pipeline: pipeline
+      ).map { |p| p.topic }
+    end
+
+    ##
+    # Find a change by topic.
+    #
+    # @option enterprise [String] the enterprise to fetch org from, defaults to
+    # default.
+    # @option organization [String] the organization to fetch from.
+    # @option project [String] the project to fetch from.
+    # @option pipeline [String] the pipeline to fetch from.
+    # @option topic [String] the topic to fetch a change from.
+    #
+    def change_by_topic(enterprise: @enterprise, organization: @organization, project: @project, pipeline: @pipeline, topic: nil)
+      o = self.pipeline(
+        enterprise: enterprise,
+        organization: organization,
+        project: project,
+        pipeline: pipeline
+      ).select { |p| p.topic.eql?(topic) }.first
+      AutomateSoup::Change.new o
+    end
+
+    ##
+    # Approve a change by change topic.
+    #
+    # @option enterprise [String] the enterprise to fetch org from, defaults to
+    # default.
+    # @option organization [String] the organization to fetch from.
+    # @option project [String] the project to fetch from.
+    # @option pipeline [String] the pipeline to fetch from.
+    # @option topic [String] the change topic to approve
+    # @option wait [Boolean] to wait for the approval stages to complete.
+    # @option timeout [Integer] the time in seconds to wait between requests defaults
+    # to 10
+    # @option retries [Integer] the amount of retries to make, defaults to 5
+    #
+    def approve_change(enterprise: @enterprise, organization: @organization, project: @project, pipeline: @pipeline, topic: nil, wait: false, timeout: 10, retries: 5)
+      o = self.change_by_topic(
+        enterprise: enterprise,
+        organization: organization,
+        project: project,
+        pipeline: pipeline,
+        topic: topic
+      )
+      if wait && !o.approvable? && !o.deliverable?
+        times = 1
+        while times <= retries
+          o = self.change_by_topic(
+            enterprise: enterprise,
+            organization: organization,
+            project: project,
+            pipeline: pipeline,
+            topic: topic
+          )
+          break if o.approvable?
+          return false if o.current_stage.failed?
+          puts "Stage #{o.current_stage.stage}: #{o.current_stage.status} retries #{times}/#{retries}"
+          sleep timeout
+          times += 1
+        end
+      end
+
+      o.approve
+      return true if !wait && o.deliverable?
+      times = 1
+      while times <= retries
+        o = self.change_by_topic(
+          enterprise: enterprise,
+          organization: organization,
+          project: project,
+          pipeline: pipeline,
+          topic: topic
+        )
+        break if o.deliverable?
+        return false if o.current_stage.failed?
+        puts "Stage #{o.current_stage.stage}: #{o.current_stage.status} retries #{times}/#{retries}"
+        times += 1
+        sleep timeout
+      end
+      true
+    end
+
+
+    ##
+    # Delivery a change by a topic
+    #
+    # @option enterprise [String] the enterprise to fetch org from, defaults to
+    # default.
+    # @option organization [String] the organization to fetch from.
+    # @option project [String] the project to fetch from.
+    # @option pipeline [String] the pipeline to fetch from.
+    # @option topic [String] the change topic to approve
+    # @option wait [Boolean] to wait for the approval stages to complete.
+    # @option timeout [Integer] the time in seconds to wait between requests defaults
+    # to 10
+    # @option retries [Integer] the amount of retries to make, defaults to 5
+    #
+    def deliver_change(enterprise: @enterprise, organization: @organization, project: @project, pipeline: @pipeline, topic: nil, wait: false, timeout: 10, retries: 5)
+      o = self.change_by_topic(
+        enterprise: enterprise,
+        organization: organization,
+        project: project,
+        pipeline: pipeline,
+        topic: topic
+      )
+      return false if !o.deliverable?
+      if wait && !o.deliverable?
+        times = 1
+        while times <= retries
+          o = self.change_by_topic(
+            enterprise: enterprise,
+            organization: organization,
+            project: project,
+            pipeline: pipeline,
+            topic: topic
+          )
+          break if o.deliverable?
+          return false if o.current_stage.failed?
+          puts "Stage #{o.current_stage.stage}: #{o.current_stage.status} retries #{times}/#{retries}"
+          sleep timeout
+          times += 1
+        end
+      end
+
+      o.deliver
+      return true if !wait && o.delivered?
+      times = 1
+      while times <= retries
+        o = self.change_by_topic(
+          enterprise: enterprise,
+          organization: organization,
+          project: project,
+          pipeline: pipeline,
+          topic: topic
+        )
+        break if o.delivered?
+        return false if o.current_stage.failed?
+        puts "Stage #{o.current_stage.stage}: #{o.current_stage.status} retries #{times}/#{retries}"
+        times += 1
+        sleep timeout
+      end
+      true
+    end
+
+    private
+
+    def password_credentials(username, password)
+      AutomateSoup::Credentials.new(
+        username: username,
+        password: password
+      )
+    end
+
+    def token_credentials(username, token)
+      AutomateSoup::Credentials.new(
+        username: username,
+        token: token
+      )
+    end
+  end
+end

data/lib/automate_soup/api.rb

@@ -0,0 +1,112 @@
+module AutomateSoup
+  ##
+  # API class to interact with chef automate
+  class API
+    def initialize(soup)
+      @soup = soup
+    end
+
+    ##
+    # Get the status of the Automate API
+    #
+    def status
+      AutomateSoup::Rest.get(
+        url: "#{@soup.url}/api/_status",
+        username: @soup.credentials.username,
+        token: @soup.credentials.token
+      )
+    end
+
+    ##
+    # Get the organizations given the enterprise.
+    #
+    # @param enterprise [String] the enterprise to fetch orgs from, defaults to
+    # default.
+    #
+    def orgs(enterprise = 'default')
+      @hash = AutomateSoup::Rest.get(
+        url: "#{@soup.url}/api/v0/e/#{enterprise}/orgs",
+        username: @soup.credentials.username,
+        token: @soup.credentials.token
+      )
+      raise "Failed to fetch orgs under enterprise #{enterprise}" unless @hash['orgs']
+      @hash['orgs']
+    end
+
+    ##
+    # Get the projects under and organization given the enterprise.
+    #
+    # @option enterprise [String] the enterprise to fetch org from, defaults to
+    # default.
+    # @option organization [String] the organization to fetch projects from.
+    #
+    def projects(enterprise: 'default', organization: nil)
+      @hash = AutomateSoup::Rest.get(
+        url: "#{@soup.url}/api/v0/e/#{enterprise}/orgs/#{organization}/projects",
+        username: @soup.credentials.username,
+        token: @soup.credentials.token
+      )
+
+    rescue JSON::ParserError
+      raise "Failed to fetch projects under organization #{organization} enterprise #{enterprise}"
+    end
+
+    ##
+    # Fetch a project under an enterprise, organization pair
+    #
+    # @option enterprise [String] the enterprise to fetch org from, defaults to
+    # default.
+    # @option organization [String] the organization to fetch projects from.
+    # @option project [String] the organization to fetch projects from.
+    #
+    def project(enterprise: 'default', organization: nil, project: nil)
+      @hash = AutomateSoup::Rest.get(
+        url: "#{@soup.url}/api/v0/e/#{enterprise}/orgs/#{organization}/projects/#{project}/pipelines",
+        username: @soup.credentials.username,
+        token: @soup.credentials.token
+      )
+
+    rescue JSON::ParserError
+      raise "Failed to fetch projects under organization #{organization} enterprise #{enterprise}"
+    end
+
+    ##
+    # Fetch all project pipelines under an enterprise, organization pair
+    #
+    # @option enterprise [String] the enterprise to fetch org from, defaults to
+    # default.
+    # @option organization [String] the organization to fetch pipelines from.
+    # @option project [String] the project to fetch pipelines from.
+    #
+    def pipelines(enterprise: 'default', organization: nil, project: nil)
+      @hash = AutomateSoup::Rest.get(
+        url: "#{@soup.url}/api/v0/e/#{enterprise}/orgs/#{organization}/projects/#{project}/pipelines",
+        username: @soup.credentials.username,
+        token: @soup.credentials.token
+      )
+      @hash['pipelines']
+
+    rescue JSON::ParserError
+      raise "Failed to fetch pipelines under organization #{organization} enterprise #{enterprise}"
+    end
+
+    ##
+    # Fetch a projects pipeline under an enterprise, organization pair
+    #
+    # @option enterprise [String] the enterprise to fetch org from, defaults to
+    # default.
+    # @option organization [String] the organization to fetch from.
+    # @option project [String] the project to fetch from.
+    # @option pipeline [String] the pipeline to fetch from.
+    #
+    def pipeline(enterprise: 'default', organization: nil, project: nil, pipeline: nil)
+      @hash = AutomateSoup::Rest.get(
+        url: "#{@soup.url}/api/v0/e/#{enterprise}/orgs/#{organization}/projects/#{project}/changes?pipeline=#{pipeline}&limit=25",
+        username: @soup.credentials.username,
+        token: @soup.credentials.token
+      )
+    rescue JSON::ParserError
+      raise "Failed to fetch pipelines under organization #{organization} enterprise #{enterprise}"
+    end
+  end
+end

data/lib/automate_soup/change.rb

@@ -0,0 +1,105 @@
+require 'ostruct'
+
+module AutomateSoup
+  ##
+  # Class to represent operations on a change.
+  #
+  class Change
+    def initialize(hash)
+      @source = OpenStruct.new hash
+    end
+
+    ##
+    # Delegate method missing to the underlying OpenStruct
+    #
+    def method_missing(method, *args, &block)
+      @source.send(method, *args, &block)
+    end
+
+    ##
+    # Determing the current stage of the change.
+    # @return [AutomateSoup::Stage] the current stage.
+    def current_stage
+      Stage.new @source.stages.last
+    end
+
+    ##
+    # Wrapper for the _links property on the struct
+    #
+    def links
+      @source._links
+    end
+
+    ##
+    # Determine if the change has been delivered successfully.
+    #
+    # @return [Boolean] if this change is delivered
+    def delivered?
+      (current_stage.stage.eql?('delivered') &&
+        current_stage.status.eql?('passed') &&
+        !AutomateSoup.url.nil? &&
+        !AutomateSoup.credentials.nil?)
+    end
+
+    ##
+    # Determine if the change is deliverable.
+    #
+    # @return [Boolean] if this change is deliverable
+    def deliverable?
+      (current_stage.stage.eql?('acceptance') &&
+        current_stage.status.eql?('passed') &&
+        !AutomateSoup.url.nil? &&
+        !AutomateSoup.credentials.nil? &&
+        !links.nil? &&
+        !links['deliver'].nil? &&
+        !links['deliver']['href'].nil?)
+    end
+
+    ##
+    # Determine if the change is approvable.
+    #
+    # @return [Boolean] if this change is approvable
+    def approvable?
+      (current_stage.stage.eql?('verify') &&
+        current_stage.status.eql?('passed') &&
+        !AutomateSoup.url.nil? &&
+        !AutomateSoup.credentials.nil? &&
+        !links.nil? &&
+        !links['approve'].nil? &&
+        !links['approve']['href'].nil?)
+    end
+
+    ##
+    # Approve this change.
+    def approve
+      return nil if current_stage.stage != 'verify'
+      raise 'Must run AutomateSoup.setup first' if AutomateSoup.url.nil? || AutomateSoup.credentials.nil?
+      raise 'Approve link not available' if links.nil? || links['approve'].nil? || links['approve']['href'].nil?
+      url = "#{AutomateSoup.url}#{links['approve']['href']}"
+      res = AutomateSoup::Rest.post(
+        url: url,
+        username: AutomateSoup.credentials.username,
+        token: AutomateSoup.credentials.token
+      )
+      raise "Failed to approve change: #{res.code}" if res.code != '204'
+      true
+    end
+
+    ##
+    # Deliver this change.
+    def deliver
+      raise 'Must approve change first' if current_stage.stage.eql? 'verify'
+      return nil if current_stage.stage != 'acceptance'
+      raise 'Must run AutomateSoup.setup first' if AutomateSoup.url.nil? || AutomateSoup.credentials.nil?
+      raise 'Deliver link not available' if links.nil? || links['deliver'].nil? || links['deliver']['href'].nil?
+      url = "#{AutomateSoup.url}#{links['deliver']['href']}"
+      res = AutomateSoup::Rest.post(
+        url: url,
+        username: AutomateSoup.credentials.username,
+        token: AutomateSoup.credentials.token
+      )
+      raise "Failed to deliver change: #{res.code}" if res.code != '204'
+      true
+    end
+  end
+end