semaph 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 31aeabe99b27b7a10bc26f91c6a60e87e3374b309df5e41b8354694d99bd1a90
-  data.tar.gz: 34499279ff5fedb14739093655ad29ff703c9c3d40222208783106d73d746841
+  metadata.gz: 7db37cbca829e1b13372c7a8687b86080b1e4a579bbb7707e6cc207ebdcb4ba1
+  data.tar.gz: 4b5015379f62ad0382991f26b525583d2a6e077889071e5bde58dc1399d69ada
 SHA512:
-  metadata.gz: 47939331aee8435b5584f29ab39cf9647730dc0ead3b340c20175df3da849120aec5e9b97d3cd7dc116aa6044ac4fd9e1c4648b6ece862afe01a40b8e5007da9
-  data.tar.gz: 4f7b74225fd180ea85fad14c73a8a808733fc1d4836b69b99069a25314996bdd70066c1c1bb35b5e247cbeeefe5191760af50102d338e65992fdbd44ebfe529c
+  metadata.gz: 243de9cc3425299a5d7a5a11d3a6e06a89e56ad22e0bab59fe4568544fc8e05f0a6e902363497d493811a00c30f84a95456a0679417fb7d4d39b10ad35ece692
+  data.tar.gz: f1fd8d22e22885357f0b5c1ba962ac1edb91b61b6ab3b9e03cfec9aeda88197a40bfcfe2b047417d3d2629e5eb8f9fa3e32b9dde40e8feefeb09bae8e7e5527d

data/.rubocop.yml

@@ -1,3 +1,42 @@
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
+Style/ExponentialNotation:
+  Enabled: true
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+
+Style/RedundantRegexpEscape:
+  Enabled: true
+
+Style/SlicingWithRange:
+  Enabled: true
+
 Style/Documentation:
   Enabled: false
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    semaph (0.6.0)
+    semaph (0.7.0)
       faraday
       rainbow
       shell_shock

data/lib/semaph/{api.rb → client.rb}

@@ -3,7 +3,17 @@ require "json"
 
 module Semaph
   # Refer to https://docs.semaphoreci.com/reference/api-v1alpha/
-  class Api
+  class Client
+    class RequestException < RuntimeError
+      attr_reader :url, :response
+
+      def initialize(url, response)
+        @url = url
+        @response = response
+        super("http response #{response.status} received for #{url}:\n#{response.body}")
+      end
+    end
+
     attr_reader :host, :name
 
     def initialize(token, host)
@@ -42,10 +52,22 @@ module Semaph
       get "pipelines/#{id}", { detailed: true }
     end
 
+    def promotions(pipeline_id)
+      get "promotions", { pipeline_id: pipeline_id }
+    end
+
+    def promote(pipeline_id, name)
+      post "promotions", { pipeline_id: pipeline_id, name: name }
+    end
+
     def job(id)
       get "jobs/#{id}"
     end
 
+    def stop_job(id)
+      post "jobs/#{id}/stop"
+    end
+
     def job_log(id)
       get_raw "jobs/#{id}/plain_logs.json"
     end
@@ -87,8 +109,7 @@ module Semaph
     def check_response(response, url)
       return response.body if response.status == 200
 
-      puts "http response #{response.status} received for #{url}:\n#{response.body}"
-      exit 1
+      raise RequestException.new(url, response)
     end
   end
 end

data/lib/semaph/formatting.rb

@@ -1,3 +1,5 @@
+require "rainbow"
+
 module Semaph
   module Formatting
     TIME_FORMAT = "%m-%d %H:%M".freeze
@@ -5,5 +7,17 @@ module Semaph
     def self.time(time)
       time.strftime(TIME_FORMAT)
     end
+
+    def self.hours_minutes_seconds(total_seconds)
+      seconds = total_seconds % 60
+      minutes = (total_seconds / 60) % 60
+      hours = total_seconds / (60 * 60)
+
+      format("%02<hours>d:%02<minutes>d:%02<seconds>d", hours: hours, minutes: minutes, seconds: seconds)
+    end
+
+    def self.index(number)
+      Rainbow(number.to_s.rjust(2)).yellow
+    end
   end
 end

data/lib/semaph/model/job.rb

@@ -22,6 +22,14 @@ module Semaph
         assign_from_block(raw_block)
       end
 
+      def stop
+        pipeline.workflow.project.client.stop_job(id)
+      end
+
+      def show
+        pp pipeline.workflow.project.client.job(id)
+      end
+
       def write_log(base)
         FileUtils.mkdir_p(base)
         filename = "#{base}/#{id}.log"

data/lib/semaph/model/pipeline.rb

@@ -1,15 +1,18 @@
+require "semaph/formatting"
 require "semaph/model/job_collection"
+require "semaph/model/promotion_collection"
 
 module Semaph
   module Model
     class Pipeline
-      attr_reader :workflow, :raw, :id, :yaml, :state, :result
+      attr_reader :workflow, :raw, :id, :name, :yaml, :state, :result
 
       def initialize(workflow, raw)
         @workflow = workflow
         @raw = raw
         @id = raw["ppl_id"]
         @yaml = raw["yaml_file_name"]
+        @name = raw["name"]
         @state = raw["state"]
         @result = raw["result"]
         %w[created done pending queuing running stopping].each do |name|
@@ -17,16 +20,33 @@ module Semaph
         end
       end
 
+      def promote(name)
+        workflow.project.client.promote(id, name)
+      end
+
       def job_collection
         @job_collection ||= JobCollection.new(self)
       end
 
+      def promotion_collection
+        @promotion_collection ||= PromotionCollection.new(self)
+      end
+
       def description
-        "#{icon} #{yaml}"
+        [
+          icon,
+          time,
+          name,
+          "(#{yaml})",
+        ].compact.join(" ")
+      end
+
+      def done?
+        @state == "DONE"
       end
 
       def icon
-        return "🔵" unless @state == "DONE"
+        return "🔵" unless done?
 
         return "⛔" if @result == "STOPPED"
 
@@ -37,6 +57,12 @@ module Semaph
 
       private
 
+      def time
+        return ::Semaph::Formatting.hours_minutes_seconds(@done_at.to_i - @created_at.to_i) if done?
+
+        ::Semaph::Formatting.hours_minutes_seconds(Time.now.to_i - @created_at.to_i)
+      end
+
       def extract_time(name)
         key = "#{name}_at"
         return if raw[key]["seconds"].zero?

data/lib/semaph/model/promotion.rb

@@ -0,0 +1,31 @@
+require "semaph/formatting"
+
+module Semaph
+  module Model
+    class Promotion
+      attr_reader :pipeline, :raw
+
+      def initialize(pipeline, raw)
+        @pipeline = pipeline
+        @raw = raw
+        @name = raw["name"]
+        @status = raw["status"]
+        @triggered_at = Time.at(raw["triggered_at"]["seconds"])
+      end
+
+      def description
+        [
+          status_icon,
+          Semaph::Formatting.time(@triggered_at),
+          @name,
+        ].join(" ")
+      end
+
+      def status_icon
+        return "🟢" if @status == "passed"
+
+        "🔴"
+      end
+    end
+  end
+end

data/lib/semaph/model/promotion_collection.rb

@@ -0,0 +1,21 @@
+require "semaph/model/promotion"
+
+module Semaph
+  module Model
+    class PromotionCollection
+      attr_reader :all, :pipeline
+
+      def initialize(pipeline)
+        @pipeline = pipeline
+      end
+
+      def reload
+        workflow = @pipeline.workflow
+        project = workflow.project
+        @all = project.client.promotions(@pipeline.id).map do |promotion_response|
+          Promotion.new(@pipeline, promotion_response)
+        end
+      end
+    end
+  end
+end

data/lib/semaph/shells/organisation/organisation_shell.rb

@@ -1,4 +1,4 @@
-require "semaph/api"
+require "semaph/client"
 require "semaph/commands/reload_command"
 require "semaph/model/project_collection"
 require "semaph/shells/organisation/projects_list_command"
@@ -12,7 +12,7 @@ module Semaph
         include ShellShock::Context
 
         def initialize(organisation)
-          @client = ::Semaph::Api.new(organisation["auth"]["token"], organisation["host"])
+          @client = ::Semaph::Client.new(organisation["auth"]["token"], organisation["host"])
           @prompt = "🏗  #{@client.name} > "
           add_commands
           @project_list_command.execute("")

data/lib/semaph/shells/organisation/projects_select_command.rb

@@ -18,6 +18,12 @@ module Semaph
 
         def execute(name)
           selected_project = @project_collection.all.find { |project| project.name == name }
+
+          unless selected_project
+            puts "There is no project called #{name}"
+            return
+          end
+
           ::Semaph::Shells::Project::ProjectShell.new(selected_project).push
         end
       end

data/lib/semaph/shells/organisations/organisations_select_command.rb

@@ -17,7 +17,14 @@ module Semaph
         end
 
         def execute(name)
-          ::Semaph::Shells::Organisation::OrganisationShell.new(@organisations[name]).push
+          organisation = @organisations[name]
+
+          unless organisation
+            puts "There is no organisation called #{name}"
+            return
+          end
+
+          ::Semaph::Shells::Organisation::OrganisationShell.new(organisation).push
         end
       end
     end

data/lib/semaph/shells/pipeline/job_debug_command.rb

@@ -0,0 +1,29 @@
+module Semaph
+  module Shells
+    module Pipeline
+      class JobDebugCommand
+        attr_reader :usage, :help
+
+        def initialize(job_collection)
+          @job_collection = job_collection
+          @usage = "<job index>"
+          @help = "debug job"
+        end
+
+        def execute(index_string)
+          index = index_string.to_i - 1
+
+          job = @job_collection.all[index]
+
+          unless job
+            puts "There is no job at position #{index}"
+            return
+          end
+
+          puts "Debugging #{job.description}"
+          system("sem debug job #{job.id}")
+        end
+      end
+    end
+  end
+end

data/lib/semaph/shells/pipeline/job_show_command.rb

@@ -0,0 +1,28 @@
+module Semaph
+  module Shells
+    module Pipeline
+      class JobShowCommand
+        attr_reader :usage, :help
+
+        def initialize(job_collection)
+          @job_collection = job_collection
+          @usage = "<job index>"
+          @help = "show job"
+        end
+
+        def execute(index_string)
+          index = index_string.to_i - 1
+
+          job = @job_collection.all[index]
+
+          unless job
+            puts "There is no job at position #{index}"
+            return
+          end
+
+          puts job.show
+        end
+      end
+    end
+  end
+end

data/lib/semaph/shells/pipeline/job_stop_command.rb

@@ -0,0 +1,28 @@
+module Semaph
+  module Shells
+    module Pipeline
+      class JobStopCommand
+        attr_reader :usage, :help
+
+        def initialize(job_collection)
+          @job_collection = job_collection
+          @usage = "<job index>"
+          @help = "stop job"
+        end
+
+        def execute(index_string)
+          index = index_string.to_i - 1
+
+          job = @job_collection.all[index]
+
+          unless job
+            puts "There is no job at position #{index}"
+            return
+          end
+
+          job.stop
+        end
+      end
+    end
+  end
+end

data/lib/semaph/shells/pipeline/jobs_list_command.rb

@@ -1,3 +1,5 @@
+require "semaph/formatting"
+
 module Semaph
   module Shells
     module Pipeline
@@ -9,10 +11,10 @@ module Semaph
           @help = "list jobs"
         end
 
-        def execute(_whatever)
+        def execute(_whatever = nil)
           @job_collection.reload
           @job_collection.all.each_with_index do |job, index|
-            puts "#{index + 1} #{job.description}"
+            puts [::Semaph::Formatting.index(index + 1), job.description].join(" ")
           end
         end
       end

data/lib/semaph/shells/pipeline/jobs_poll_command.rb

@@ -1,34 +1,33 @@
+require "semaph/formatting"
+
 module Semaph
   module Shells
     module Pipeline
       class JobsPollCommand
         attr_reader :usage, :help, :job_collection
 
-        def initialize(job_collection)
+        def initialize(job_collection, list_command)
           @job_collection = job_collection
+          @list_command = list_command
           @help = "poll jobs"
           @can_notify = !`which terminal-notifier`.chomp.empty?
         end
 
-        def execute(_whatever)
-          while job_collection.incomplete.count.positive?
-            report_incomplete(job_collection.incomplete)
-            if job_collection.failed.count.positive?
-              report_failures(job_collection.failed)
-              return
-            end
-            sleep 20
-            job_collection.reload
-          end
+        def execute(_whatever = nil)
+          report_and_reload(15) while job_collection.incomplete.count.positive? && job_collection.failed.count.zero?
           report_final
         end
 
         private
 
+        def report_and_reload(period)
+          report_incomplete(job_collection.incomplete)
+          sleep period
+          job_collection.reload
+        end
+
         def report_final
-          job_collection.all.each_with_index do |job, index|
-            puts "#{index + 1} #{job.description}"
-          end
+          @list_command.execute
           failed_job_count = job_collection.failed.count
           notify(
             "Workflow completed",
@@ -43,12 +42,6 @@ module Semaph
           incomplete_jobs.each { |job| puts job.description }
         end
 
-        def report_failures(failed_jobs)
-          puts "Some jobs have failed:"
-          failed_jobs.each { |job| puts job.description }
-          notify("Job Failures", "#{failed_jobs.count} jobs have failed", true)
-        end
-
         def notify(title, message, failed)
           return unless @can_notify
 

data/lib/semaph/shells/pipeline/pipeline_shell.rb

@@ -1,8 +1,13 @@
 require "semaph/commands"
-require "semaph/shells/pipeline/jobs_list_command"
+require "semaph/shells/pipeline/job_debug_command"
 require "semaph/shells/pipeline/job_log_command"
 require "semaph/shells/pipeline/job_log_grep_command"
+require "semaph/shells/pipeline/job_show_command"
+require "semaph/shells/pipeline/job_stop_command"
+require "semaph/shells/pipeline/jobs_list_command"
 require "semaph/shells/pipeline/jobs_poll_command"
+require "semaph/shells/pipeline/promote_command"
+require "semaph/shells/pipeline/promotions_list_command"
 require "shell_shock/context"
 
 module Semaph
@@ -18,27 +23,37 @@ module Semaph
           workflow = pipeline.workflow
           project = workflow.project
           @prompt = "🏗  #{project.client.name} #{project.name} #{workflow.id} #{pipeline.yaml} > "
+          add_command ::Semaph::Commands::ReloadCommand.new, "reload" if ENV["SEMAPH_RELOAD"]
           add_commands
-          @jobs_list_command.execute("")
+          jobs_list_command.execute
         end
 
         private
 
         def add_commands
-          add_command ::Semaph::Commands::ReloadCommand.new, "reload" if ENV["SEMAPH_RELOAD"]
-          workflow = pipeline.workflow
-          ::Semaph::Commands.workflow_commands(self, workflow)
+          ::Semaph::Commands.workflow_commands(self, pipeline.workflow)
           add_job_collection_commands(pipeline.job_collection)
+          add_command PromoteCommand.new(pipeline), "promote"
+          add_command PromotionsListCommand.new(pipeline.promotion_collection), "list-promotions"
         end
 
         def add_job_collection_commands(job_collection)
-          @jobs_list_command = JobsListCommand.new(job_collection)
-          add_command @jobs_list_command, "list-jobs", "ls"
-          add_command JobsPollCommand.new(job_collection), "poll-jobs"
-          add_command JobLogCommand.new(job_collection), "job-log"
+          add_command JobsPollCommand.new(job_collection, jobs_list_command), "poll"
+          add_command JobLogCommand.new(job_collection), "log"
+          add_command JobDebugCommand.new(job_collection), "debug"
+          add_command JobShowCommand.new(job_collection), "show"
+          add_command JobStopCommand.new(job_collection), "stop"
           add_command JobLogGrepCommand.new(job_collection, :all), "grep-all-logs"
           add_command JobLogGrepCommand.new(job_collection, :failed), "grep-failed-logs"
         end
+
+        def jobs_list_command
+          return @jobs_list_command if @jobs_list_command
+
+          @jobs_list_command = JobsListCommand.new(pipeline.job_collection)
+          add_command @jobs_list_command, "list-jobs", "ls"
+          @jobs_list_command
+        end
       end
     end
   end

data/lib/semaph/shells/pipeline/promote_command.rb

@@ -0,0 +1,21 @@
+module Semaph
+  module Shells
+    module Pipeline
+      class PromoteCommand
+        attr_reader :usage, :help
+
+        def initialize(pipeline)
+          @pipeline = pipeline
+          @usage = "<promotion name>"
+          @help = "promote pipeline"
+        end
+
+        def execute(name)
+          @pipeline.promote(name.chomp.strip)
+        rescue ::Semaph::Client::RequestException => e
+          puts e.message
+        end
+      end
+    end
+  end
+end

data/lib/semaph/shells/pipeline/promotions_list_command.rb

@@ -0,0 +1,21 @@
+module Semaph
+  module Shells
+    module Pipeline
+      class PromotionsListCommand
+        attr_reader :usage, :help
+
+        def initialize(promotion_collection)
+          @promotion_collection = promotion_collection
+          @help = "list promotions"
+        end
+
+        def execute(_whatever)
+          @promotion_collection.reload
+          @promotion_collection.all.each_with_index do |promotion, index|
+            puts "#{index + 1} #{promotion.description}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/semaph/shells/project/workflows_list_command.rb

@@ -1,3 +1,5 @@
+require "semaph/formatting"
+
 module Semaph
   module Shells
     module Project
@@ -15,7 +17,7 @@ module Semaph
           @workflow_collection.all.each_with_index do |workflow, index|
             next unless workflow.branch.include?(branch)
 
-            puts "#{index + 1} #{workflow.description}"
+            puts [::Semaph::Formatting.index(index + 1), workflow.description].join(" ")
           end
         end
       end

data/lib/semaph/shells/workflow/pipelines_list_command.rb

@@ -1,3 +1,5 @@
+require "semaph/formatting"
+
 module Semaph
   module Shells
     module Workflow
@@ -12,7 +14,7 @@ module Semaph
         def execute(_whatever)
           @pipeline_collection.reload
           @pipeline_collection.all.each_with_index do |pipeline, index|
-            puts "#{index + 1} #{pipeline.description}"
+            puts [::Semaph::Formatting.index(index + 1), pipeline.description].join(" ")
           end
         end
       end

data/lib/semaph/version.rb

@@ -1,3 +1,3 @@
 module Semaph
-  VERSION = "0.6.0".freeze
+  VERSION = "0.7.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: semaph
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Mark Ryall
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-06-05 00:00:00.000000000 Z
+date: 2020-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -103,7 +103,7 @@ files:
 - bin/setup
 - exe/semaph
 - lib/semaph.rb
-- lib/semaph/api.rb
+- lib/semaph/client.rb
 - lib/semaph/commands.rb
 - lib/semaph/commands/reload_command.rb
 - lib/semaph/commands/rerun_workflow_command.rb
@@ -116,6 +116,8 @@ files:
 - lib/semaph/model/pipeline_collection.rb
 - lib/semaph/model/project.rb
 - lib/semaph/model/project_collection.rb
+- lib/semaph/model/promotion.rb
+- lib/semaph/model/promotion_collection.rb
 - lib/semaph/model/workflow.rb
 - lib/semaph/model/workflow_collection.rb
 - lib/semaph/shells/organisation/organisation_shell.rb
@@ -124,11 +126,16 @@ files:
 - lib/semaph/shells/organisations/organisations_list_command.rb
 - lib/semaph/shells/organisations/organisations_select_command.rb
 - lib/semaph/shells/organisations/organisations_shell.rb
+- lib/semaph/shells/pipeline/job_debug_command.rb
 - lib/semaph/shells/pipeline/job_log_command.rb
 - lib/semaph/shells/pipeline/job_log_grep_command.rb
+- lib/semaph/shells/pipeline/job_show_command.rb
+- lib/semaph/shells/pipeline/job_stop_command.rb
 - lib/semaph/shells/pipeline/jobs_list_command.rb
 - lib/semaph/shells/pipeline/jobs_poll_command.rb
 - lib/semaph/shells/pipeline/pipeline_shell.rb
+- lib/semaph/shells/pipeline/promote_command.rb
+- lib/semaph/shells/pipeline/promotions_list_command.rb
 - lib/semaph/shells/project/project_shell.rb
 - lib/semaph/shells/project/workflows_list_command.rb
 - lib/semaph/shells/project/workflows_select_command.rb