semaph 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f87c47f0c0284d850593103961da8d6a7dc749042dc774aaa8f16f59f4fa183
-  data.tar.gz: 4c35a0cdfec02111a076738d6be9e2b18f1bd2a598bb3020f859840a21613556
+  metadata.gz: 31aeabe99b27b7a10bc26f91c6a60e87e3374b309df5e41b8354694d99bd1a90
+  data.tar.gz: 34499279ff5fedb14739093655ad29ff703c9c3d40222208783106d73d746841
 SHA512:
-  metadata.gz: 348e0df084693205e3d59a18e886674d5783cf451b362d1dbf6aa0e5acd6dcaa5715313339e3c81c7a1dffb5f590a093684f99cc668c33dbc983182abce9d4bf
-  data.tar.gz: a3c64e20563744c6224b0cbd7deac2fa50a8c3d0c53eceda20c8f8d9d294cb25e8307f489d0ebebfe582c1d1fad5eb25d88e897fd5ecb4e91b294eaa76200a46
+  metadata.gz: 47939331aee8435b5584f29ab39cf9647730dc0ead3b340c20175df3da849120aec5e9b97d3cd7dc116aa6044ac4fd9e1c4648b6ece862afe01a40b8e5007da9
+  data.tar.gz: 4f7b74225fd180ea85fad14c73a8a808733fc1d4836b69b99069a25314996bdd70066c1c1bb35b5e247cbeeefe5191760af50102d338e65992fdbd44ebfe529c

data/.semaphore/semaphore.yml

@@ -16,4 +16,8 @@ blocks:
       - name: Build
         commands:
           - checkout
-          - echo "done"
+          - sem-version ruby $(grep ruby .tool-versions | cut -d ' ' -f 2)
+          - cache restore $(git ls-tree HEAD Gemfile.lock | cut -f3 -d$' ' | cut -f1 -d$'\t')
+          - bundle install --deployment --path vendor/bundle
+          - cache store $(git ls-tree HEAD Gemfile.lock | cut -f3 -d$' ' | cut -f1 -d$'\t') vendor/bundle
+          - bundle exec rake

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    semaph (0.5.0)
+    semaph (0.6.0)
       faraday
       rainbow
       shell_shock
@@ -9,18 +9,37 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    ast (2.4.0)
     coderay (1.1.2)
     faraday (1.0.1)
       multipart-post (>= 1.2, < 3)
     method_source (1.0.0)
     minitest (5.14.1)
     multipart-post (2.1.1)
+    parallel (1.19.1)
+    parser (2.7.1.3)
+      ast (~> 2.4.0)
     pry (0.13.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
     rainbow (3.0.0)
     rake (12.3.3)
+    regexp_parser (1.7.0)
+    rexml (3.2.4)
+    rubocop (0.85.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.0.3)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.0.3)
+      parser (>= 2.7.0.1)
+    ruby-progressbar (1.10.1)
     shell_shock (0.0.5)
+    unicode-display_width (1.7.0)
 
 PLATFORMS
   ruby
@@ -29,6 +48,7 @@ DEPENDENCIES
   minitest (~> 5.0)
   pry
   rake (~> 12.0)
+  rubocop
   semaph!
 
 BUNDLED WITH

data/Rakefile

@@ -1,5 +1,6 @@
 require "bundler/gem_tasks"
 require "rake/testtask"
+require "rubocop/rake_task"
 
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
@@ -7,4 +8,6 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList["test/**/*_test.rb"]
 end
 
-task default: :test
+RuboCop::RakeTask.new(:cop)
+
+task default: %i[cop test]

data/lib/semaph/commands.rb

@@ -0,0 +1,63 @@
+require "semaph/commands/reload_command"
+require "semaph/commands/rerun_workflow_command"
+require "semaph/commands/stop_workflow_command"
+require "semaph/commands/visit_url_command"
+
+module Semaph
+  module Commands
+    def self.workflow_commands(shell, workflow)
+      shell.add_command ::Semaph::Commands::RerunWorkflowCommand.new(workflow), "rerun"
+      shell.add_command ::Semaph::Commands::StopWorkflowCommand.new(workflow), "stop"
+      add_open_workflow_command(shell, workflow)
+      add_open_branch_command(shell, workflow)
+      add_github_commands(shell, workflow)
+    end
+
+    def self.add_open_workflow_command(shell, workflow)
+      shell.add_command(
+        ::Semaph::Commands::VisitUrlCommand.new(
+          "https://#{workflow.project.client.host}/workflows/#{workflow.id}",
+          "browse to workflow",
+        ),
+        "open-workflow",
+      )
+    end
+
+    def self.add_open_branch_command(shell, workflow)
+      shell.add_command(
+        ::Semaph::Commands::VisitUrlCommand.new(
+          "https://#{workflow.project.client.host}/branches/#{workflow.branch_id}",
+          "browse to branch in semaphore",
+        ),
+        "open-branch",
+      )
+    end
+
+    def self.add_github_commands(shell, workflow)
+      return unless workflow.project.github_url
+
+      add_github_branch(shell, workflow)
+      add_github_commit(shell, workflow)
+    end
+
+    def self.add_github_branch(shell, workflow)
+      shell.add_command(
+        ::Semaph::Commands::VisitUrlCommand.new(
+          "#{workflow.project.github_url}/tree/#{workflow.branch}",
+          "browse to the branch in github",
+        ),
+        "open-github-branch",
+      )
+    end
+
+    def self.add_github_commit(shell, workflow)
+      shell.add_command(
+        ::Semaph::Commands::VisitUrlCommand.new(
+          "#{workflow.project.github_url}/commit/#{workflow.sha}",
+          "browse to the commit in github",
+        ),
+        "open-github-commit",
+      )
+    end
+  end
+end

data/lib/semaph/commands/rerun_workflow_command.rb

@@ -1,5 +1,3 @@
-require "semaph/shells/workflow/workflow_shell"
-
 module Semaph
   module Commands
     class RerunWorkflowCommand

data/lib/semaph/commands/stop_workflow_command.rb

@@ -1,5 +1,3 @@
-require "semaph/shells/workflow/workflow_shell"
-
 module Semaph
   module Commands
     class StopWorkflowCommand

data/lib/semaph/model/job.rb

@@ -1,3 +1,5 @@
+require "fileutils"
+
 module Semaph
   module Model
     class Job
@@ -20,8 +22,17 @@ module Semaph
         assign_from_block(raw_block)
       end
 
-      def log
-        pipeline.workflow.project.client.job_log(id)
+      def write_log(base)
+        FileUtils.mkdir_p(base)
+        filename = "#{base}/#{id}.log"
+        return filename if File.exist?(filename)
+
+        puts "retrieving log for job #{id}"
+        File.open(filename, "w") do |file|
+          file.puts pipeline.workflow.project.client.job_log(id)
+        end
+
+        filename
       end
 
       def description

data/lib/semaph/model/workflow.rb

@@ -1,3 +1,4 @@
+require "semaph/formatting"
 require "semaph/model/pipeline_collection"
 
 module Semaph
@@ -9,11 +10,15 @@ module Semaph
         @project = project
         @raw = raw
         @id = raw["wf_id"]
-        @sha = raw["commit_sha"]
-        @commit = @sha.slice(0..10)
         @created_at = Time.at(raw["created_at"]["seconds"].to_i)
         @branch = raw["branch_name"]
         @branch_id = raw["branch_id"]
+        extract_git_details
+      end
+
+      def extract_git_details
+        @sha = raw["commit_sha"]
+        @commit = @sha.slice(0..10)
         @commit = `git log -n 1 --format="%h %an %s" #{sha}`.chomp if `git cat-file -t #{sha} 2>&1`.chomp == "commit"
       end
 
@@ -27,6 +32,14 @@ module Semaph
         Workflow.new(project, workflow_response["workflow"])
       end
 
+      def description
+        [
+          Semaph::Formatting.time(created_at),
+          branch,
+          commit,
+        ].join(" ")
+      end
+
       def stop
         project.client.stop_workflow(@id)
       end

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

@@ -13,6 +13,20 @@ module Semaph
         end
 
         def execute(index_string)
+          base = "tmp/logs/pipeline/#{@job_collection.pipeline.id}"
+          with_job(index_string) do |job|
+            unless job.finished?
+              puts "This job has not finished yet"
+              return
+            end
+
+            system("less #{job.write_log(base)}")
+          end
+        end
+
+        private
+
+        def with_job(index_string)
           index = index_string.to_i - 1
 
           job = @job_collection.all[index]
@@ -22,19 +36,7 @@ module Semaph
             return
           end
 
-          unless job.finished?
-            puts "This job has not finished yet"
-            return
-          end
-
-          base = "tmp/logs/pipeline/#{job.pipeline.id}"
-          FileUtils.mkdir_p(base)
-          filename = "#{base}/#{job.id}.log"
-          unless File.exist?(filename)
-            puts "retrieving log for job #{job.id}"
-            File.open(filename, "w") { |file| file.puts job.log }
-          end
-          system("less #{filename}")
+          yield job
         end
       end
     end

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

@@ -1,5 +1,3 @@
-require "fileutils"
-
 module Semaph
   module Shells
     module Pipeline
@@ -15,17 +13,12 @@ module Semaph
 
         def execute(expression)
           base = "tmp/logs/pipeline/#{job_collection.pipeline.id}"
-          FileUtils.mkdir_p(base)
           @job_collection.send(@scope).each do |job|
             unless job.finished?
               puts "skipping incomplete job #{job.id}"
               next
             end
-            filename = "#{base}/#{job.id}.log"
-            unless File.exist?(filename)
-              puts "retrieving log for job #{job.id}"
-              File.open(filename, "w") { |file| file.puts job.log }
-            end
+            job.write_log(base)
           end
           system("ag #{expression} #{base} | less")
         end

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

@@ -2,7 +2,7 @@ module Semaph
   module Shells
     module Pipeline
       class JobsPollCommand
-        attr_reader :usage, :help
+        attr_reader :usage, :help, :job_collection
 
         def initialize(job_collection)
           @job_collection = job_collection
@@ -11,25 +11,50 @@ module Semaph
         end
 
         def execute(_whatever)
-          incomplete_jobs = @job_collection.incomplete
-          while incomplete_jobs.count.positive?
-            puts "#{incomplete_jobs.count} incomplete jobs remaining:"
-            incomplete_jobs.each { |job| puts job.description }
-            failed_jobs = @job_collection.failed
-            if failed_jobs.count.positive?
-              puts "Some jobs have already failed:"
-              failed_jobs.each { |job| puts job.description }
-              `terminal-notifier -group semaph -message "#{failed_jobs.count} jobs have failed" -title "Job failures"` if @can_notify
+          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
-            incomplete_jobs = @job_collection.incomplete
+            job_collection.reload
           end
-          @job_collection.all.each_with_index do |job, index|
+          report_final
+        end
+
+        private
+
+        def report_final
+          job_collection.all.each_with_index do |job, index|
             puts "#{index + 1} #{job.description}"
           end
-          `terminal-notifier -group semaph -message "All jobs have completed" -title "Workflow completed"` if @can_notify
+          failed_job_count = job_collection.failed.count
+          notify(
+            "Workflow completed",
+            "#{job_collection.pipeline.workflow.description} completed with #{failed_job_count} failed jobs",
+            failed_job_count.positive?,
+          )
+        end
+
+        def report_incomplete(incomplete_jobs)
+          puts "polling #{job_collection.pipeline.workflow.description}"
+          puts "#{incomplete_jobs.count} incomplete jobs remaining:"
+          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
+
+          sound = failed ? "basso" : "blow"
+
+          `terminal-notifier -group semaph -message "#{message}" -title "#{title}" -sound #{sound}`
         end
       end
     end

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

@@ -1,5 +1,4 @@
-require "semaph/commands/reload_command"
-require "semaph/commands/rerun_workflow_command"
+require "semaph/commands"
 require "semaph/shells/pipeline/jobs_list_command"
 require "semaph/shells/pipeline/job_log_command"
 require "semaph/shells/pipeline/job_log_grep_command"
@@ -16,6 +15,8 @@ module Semaph
 
         def initialize(pipeline)
           @pipeline = pipeline
+          workflow = pipeline.workflow
+          project = workflow.project
           @prompt = "🏗  #{project.client.name} #{project.name} #{workflow.id} #{pipeline.yaml} > "
           add_commands
           @jobs_list_command.execute("")
@@ -23,77 +24,20 @@ module Semaph
 
         private
 
-        def project
-          workflow.project
-        end
-
-        def workflow
-          pipeline.workflow
-        end
-
-        def job_collection
-          pipeline.job_collection
+        def add_commands
+          add_command ::Semaph::Commands::ReloadCommand.new, "reload" if ENV["SEMAPH_RELOAD"]
+          workflow = pipeline.workflow
+          ::Semaph::Commands.workflow_commands(self, workflow)
+          add_job_collection_commands(pipeline.job_collection)
         end
 
-        def add_commands
+        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 JobLogGrepCommand.new(job_collection, :all), "grep-all-logs"
           add_command JobLogGrepCommand.new(job_collection, :failed), "grep-failed-logs"
-          add_command ::Semaph::Commands::RerunWorkflowCommand.new(workflow), "rerun"
-          add_open_branch_command
-          add_open_workflow_command
-          add_github_commands
-          add_command ::Semaph::Commands::ReloadCommand.new, "reload" if ENV["SEMAPH_RELOAD"]
-        end
-
-        def add_open_workflow_command
-          add_command(
-            ::Semaph::Commands::VisitUrlCommand.new(
-              "https://#{project.client.host}/workflows/#{workflow.id}",
-              "browse to workflow",
-            ),
-            "open-workflow",
-          )
-        end
-
-        def add_open_branch_command
-          add_command(
-            ::Semaph::Commands::VisitUrlCommand.new(
-              "https://#{project.client.host}/branches/#{workflow.branch_id}",
-              "browse to branch in semaphore",
-            ),
-            "open-branch",
-          )
-        end
-
-        def add_github_commands
-          return unless workflow.project.github_url
-
-          add_github_branch
-          add_github_commit
-        end
-
-        def add_github_branch
-          add_command(
-            ::Semaph::Commands::VisitUrlCommand.new(
-              "#{workflow.project.github_url}/tree/#{workflow.branch}",
-              "browse to the branch in github",
-            ),
-            "open-github-branch",
-          )
-        end
-
-        def add_github_commit
-          add_command(
-            ::Semaph::Commands::VisitUrlCommand.new(
-              "#{workflow.project.github_url}/commit/#{workflow.sha}",
-              "browse to the commit in github",
-            ),
-            "open-github-commit",
-          )
         end
       end
     end

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

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

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

@@ -1,7 +1,4 @@
-require "semaph/commands/reload_command"
-require "semaph/commands/rerun_workflow_command"
-require "semaph/commands/stop_workflow_command"
-require "semaph/commands/visit_url_command"
+require "semaph/commands"
 require "semaph/shells/workflow/pipelines_list_command"
 require "semaph/shells/workflow/pipelines_select_command"
 require "shell_shock/context"
@@ -16,6 +13,7 @@ module Semaph
 
         def initialize(workflow)
           @workflow = workflow
+          project = @workflow.project
           @prompt = "🏗  #{project.client.name} #{project.name} #{workflow.id} > "
           add_commands
           @list_command.execute("")
@@ -23,71 +21,13 @@ module Semaph
 
         private
 
-        def project
-          @workflow.project
-        end
-
-        def pipeline_collection
-          @workflow.pipeline_collection
-        end
-
         def add_commands
+          pipeline_collection = @workflow.pipeline_collection
           @list_command = PipelinesListCommand.new(pipeline_collection)
           add_command @list_command, "list-pipelines", "ls"
           add_command PipelinesSelectCommand.new(pipeline_collection), "select-pipeline", "cd"
-          add_command ::Semaph::Commands::RerunWorkflowCommand.new(workflow), "rerun"
-          add_command ::Semaph::Commands::StopWorkflowCommand.new(workflow), "stop"
-          add_open_branch_command
-          add_open_workflow_command
-          add_github_commands
           add_command ::Semaph::Commands::ReloadCommand.new, "reload" if ENV["SEMAPH_RELOAD"]
-        end
-
-        def add_open_workflow_command
-          add_command(
-            ::Semaph::Commands::VisitUrlCommand.new(
-              "https://#{project.client.host}/workflows/#{workflow.id}",
-              "browse to workflow",
-            ),
-            "open-workflow",
-          )
-        end
-
-        def add_open_branch_command
-          add_command(
-            ::Semaph::Commands::VisitUrlCommand.new(
-              "https://#{project.client.host}/branches/#{workflow.branch_id}",
-              "browse to branch in semaphore",
-            ),
-            "open-branch",
-          )
-        end
-
-        def add_github_commands
-          return unless workflow.project.github_url
-
-          add_github_branch
-          add_github_commit
-        end
-
-        def add_github_branch
-          add_command(
-            ::Semaph::Commands::VisitUrlCommand.new(
-              "#{workflow.project.github_url}/tree/#{workflow.branch}",
-              "browse to the branch in github",
-            ),
-            "open-github-branch",
-          )
-        end
-
-        def add_github_commit
-          add_command(
-            ::Semaph::Commands::VisitUrlCommand.new(
-              "#{workflow.project.github_url}/commit/#{workflow.sha}",
-              "browse to the commit in github",
-            ),
-            "open-github-commit",
-          )
+          ::Semaph::Commands.workflow_commands(self, workflow)
         end
       end
     end

data/lib/semaph/version.rb

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

data/semaph.gemspec

@@ -28,4 +28,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency "shell_shock"
 
   spec.add_development_dependency "pry"
+  spec.add_development_dependency "rubocop"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: semaph
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Mark Ryall
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-06-03 00:00:00.000000000 Z
+date: 2020-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: api client and shell for api
 email:
 - mark@ryall.name
@@ -90,6 +104,7 @@ files:
 - exe/semaph
 - lib/semaph.rb
 - lib/semaph/api.rb
+- lib/semaph/commands.rb
 - lib/semaph/commands/reload_command.rb
 - lib/semaph/commands/rerun_workflow_command.rb
 - lib/semaph/commands/stop_workflow_command.rb
@@ -129,7 +144,7 @@ metadata:
   homepage_uri: http://github.com/markryall/semaph
   source_code_uri: http://github.com/markryall/semaph
   changelog_uri: http://github.com/markryall/semaph
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -145,7 +160,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: client for semaphore 2
 test_files: []