ghamma 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 374a835681570e0824d2ee192361ed16dbfc11352cc8f8f0f69ad2a0cdaa8f7f
-  data.tar.gz: 702786830164573d586113f1f88b8c5e983e71111c9ce3226274e468a374fb61
+  metadata.gz: 26ed59a6dae9c41b8fe6a3aa7b24f7ba2cc430696acfa061094c2e1e690a437d
+  data.tar.gz: 7bc89adfb0d48a8c4cfed55c1633771fcf57889e56e67efcbe2cc4f5d4ab5d7c
 SHA512:
-  metadata.gz: 3e01904c7804ae9636d06aaad5af029736b8286200f2791851b10bdd11f6552721f7cdb2ab1c4dfe9489bd27ff98374f7d7037a15e0fb04ad22c396429b18361
-  data.tar.gz: f2fb982a98a100f66072fbc80d0c4618f1281de82442dcf59c2b551ade25466303684d7fcbf55cf56eefded0a4d43ad35ce95eb7148764e71b2dc840c08c9b51
+  metadata.gz: a0df963608fd632710848105a954214aa5c6fbc33a7a789230d372567d0de534f5320e82ce2cd0d4b5854b960528faa5f1ca64962e2ed5c7f56219b19a0bfcb4
+  data.tar.gz: 7817262789b374aa634ac3c5087d88c3e9672bcb50b783928c2bf349461278c41da2b4b9702c062b4bed7116940b1eea4e584cd67f6ba72d1774a9286be53fcb

data/CHANGELOG.md

@@ -1,6 +1,13 @@
-## [Unreleased]
+## Unreleased
 
--
+## [0.3.0] - 2023-07-04
+
+- Feature: Allow optionally specifying an output file for the CSV
+- Change: Add ID of the workflow run to the output
+- Feature: Support restricting workflow runs examined since a given date
+- Feature: Fetch all the workflow runs, not just the first 100
+- Breaking: Removed the `list-workflows` command and renamed the `duration-history` to just `duration`
+- Breaking: The `duration` command now accepts the workflow file name (or ID) instead of the name
 
 ## [0.2.0] - 2023-06-01
 

data/Gemfile.lock

@@ -1,9 +1,10 @@
 PATH
   remote: .
   specs:
-    ghamma (0.2.0)
+    ghamma (0.3.0)
       dry-cli
       http
+      tty-progressbar
 
 GEM
   remote: https://rubygems.org/
@@ -68,8 +69,16 @@ GEM
     standard-performance (1.0.1)
       lint_roller (~> 1.0)
       rubocop-performance (~> 1.16.0)
+    strings-ansi (0.2.0)
     test-unit (3.5.9)
       power_assert
+    tty-cursor (0.7.1)
+    tty-progressbar (0.18.2)
+      strings-ansi (~> 0.2)
+      tty-cursor (~> 0.7)
+      tty-screen (~> 0.8)
+      unicode-display_width (>= 1.6, < 3.0)
+    tty-screen (0.8.1)
     unf (0.1.4)
       unf_ext
     unf_ext (0.0.8.2)

data/lib/ghamma/cli/duration.rb

@@ -0,0 +1,61 @@
+require "csv"
+require "dry/cli"
+require "http"
+require "tty/progressbar"
+
+require_relative "../github_api_client"
+
+module Ghamma
+  module CLI
+    class Duration < Dry::CLI::Command
+      desc "Extract the durations of successful runs of a workflow over time"
+
+      example [
+        "tony-rowan ghamma main.yml" \
+        "  # Prints durations of all workflow runs of main.yml to STDOUT",
+        "tony-rowan ghamma main.yml --since='2023-07-01' --output='/tmp/main.csv'" \
+        "  # Saves durations of all workflow runs of main.yml since 2023-07-01 to /tmp/main.csv"
+      ]
+
+      argument :owner, required: true, desc: "The user or organisation to whom the repo belongs"
+      argument :repo, required: true, desc: "The repo to which the workflow belongs"
+      argument :workflow, required: true, desc: "The filename for the desired workflow, e.g. main.yml"
+
+      option :since, desc: "Optionally restrict workflows to those created since this date"
+      option :output, desc: "Optional file to which to output results, defaults to STDOUT"
+
+      def call(owner:, repo:, workflow:, since: nil, output: nil)
+        workflow_statement = "Fetching the durations of all workflow runs of #{workflow}"
+        since_statment = "since #{since}" if since
+
+        puts [workflow_statement, since_statment].join(" ")
+
+        progressbar = TTY::ProgressBar.new("Fetching workflow runs [:bar] :current/:total ETA: :eta", total: nil)
+
+        durations = GithubApiClient.new(owner: owner, repo: repo, token: ENV["GH_TOKEN"])
+          .fetch_workflow_duration_history(workflow, since, progressbar)
+
+        progressbar.finish
+
+        puts "Generating output"
+
+        durations_output = CSV.generate do |csv|
+          csv << ["ID", "Date", "Duration"]
+          durations.each do |duration|
+            csv << duration
+          end
+        end
+
+        if output
+          File.write(output, durations_output)
+        else
+          puts
+          puts durations_output
+          puts
+        end
+
+        puts "Done"
+      end
+    end
+  end
+end

data/lib/ghamma/cli/version.rb

@@ -0,0 +1,15 @@
+require "dry/cli"
+
+require_relative "../version"
+
+module Ghamma
+  module CLI
+    class Version < Dry::CLI::Command
+      desc "Print version"
+
+      def call(*)
+        puts VERSION
+      end
+    end
+  end
+end

data/lib/ghamma/cli.rb

@@ -1,60 +1,13 @@
-require "csv"
 require "dry/cli"
-require "http"
 
-require_relative "./github_api_client"
-require_relative "./version"
+require_relative "./cli/version"
+require_relative "./cli/duration"
 
 module Ghamma
   module CLI
     extend Dry::CLI::Registry
 
-    class Version < Dry::CLI::Command
-      desc "Print version"
-
-      def call(*)
-        puts VERSION
-      end
-    end
-
-    class ListWorkflows < Dry::CLI::Command
-      desc "List workflows on the given repo"
-
-      argument :owner, required: true
-      argument :repo, required: true
-
-      def call(owner:, repo:)
-        workflows = GithubApiClient.new(owner: owner, repo: repo, token: ENV["GH_TOKEN"]).fetch_workflows
-        puts "Found #{workflows.size} workflows"
-        workflows.each { |workflow| puts workflow[:name] }
-        puts
-      end
-    end
-
-    class DurationHistory < Dry::CLI::Command
-      desc "List the duration of each successful workflow run"
-
-      argument :owner, required: true
-      argument :repo, required: true
-      argument :workflow, required: true
-
-      def call(owner:, repo:, workflow:)
-        durations = GithubApiClient.new(owner: owner, repo: repo, token: ENV["GH_TOKEN"]).fetch_workflow_duration_history(workflow)
-
-        durations_output = CSV.generate do |csv|
-          csv << ["Date", "Duration"]
-          durations.each do |duration|
-            csv << duration
-          end
-        end
-
-        puts durations_output
-        puts
-      end
-    end
-
     register "version", Version, aliases: ["v", "-v", "--version"]
-    register "list-workflows", ListWorkflows
-    register "duration-history", DurationHistory
+    register "duration", Duration
   end
 end

data/lib/ghamma/github_api_client.rb

@@ -9,35 +9,42 @@ module Ghamma
       @authorization_header = "Bearer #{token}"
     end
 
-    def fetch_workflows
-      get("/workflows")
-        .fetch("workflows")
-        .map do |workflow_json|
-          workflow_json.transform_keys(&:to_sym).slice(:id, :name)
-        end
-    end
+    def fetch_workflow_duration_history(workflow_id, since, progressbar)
+      pages = 2 # enough to do the first loop
+      page = 1
+      timings = []
 
-    def fetch_workflow_duration_history(workflow_name)
-      workflow_id = get("/workflows").fetch("workflows")
-        .find { |workflow| workflow["name"] == workflow_name }
-        &.fetch("id", nil)
+      while page <= pages
+        since_param = ">#{since}" if since
 
-      if workflow_id.nil?
-        raise "Could not find workflow with name #{workflow_name}"
-      end
+        response = get(
+          "/workflows/#{workflow_id}/runs",
+          {page: page, per_page: 100, status: "success", exclude_pull_requests: true, created: since_param}.compact
+        )
+
+        total_count = response["total_count"]
+        progressbar.update(total: total_count)
+        pages = total_count / 100
+        page += 1
+
+        response.fetch("workflow_runs").each do |workflow_run|
+          run_timing = get("/runs/#{workflow_run["id"]}/timing")
 
-      workflow_runs = get(
-        "/workflows/#{workflow_id}}/runs",
-        {per_page: 100, status: "success", exclude_pull_requests: true}
-      ).fetch("workflow_runs")
-      .map do |workflow_run|
-        run_timing = get("/runs/#{workflow_run["id"]}/timing")
-
-        [
-          workflow_run["created_at"],
-          run_timing["run_duration_ms"]
-        ]
+          timings << [
+            workflow_run["id"],
+            workflow_run["created_at"],
+            run_timing["run_duration_ms"]
+          ]
+
+          progressbar.advance
+
+          sleep 0.1 # Try to keep under the Github rate limit
+        end
+
+        sleep 1 # Try to keep under the Github rate limit
       end
+
+      timings
     end
 
     private

data/lib/ghamma/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Ghamma
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ghamma
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Tony Rowan
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-06-01 00:00:00.000000000 Z
+date: 2023-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-cli
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: tty-progressbar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -99,6 +113,8 @@ files:
 - exe/ghamma
 - lib/ghamma.rb
 - lib/ghamma/cli.rb
+- lib/ghamma/cli/duration.rb
+- lib/ghamma/cli/version.rb
 - lib/ghamma/github_api_client.rb
 - lib/ghamma/version.rb
 - sig/ghamma.rbs