ghamma 0.1.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad500d312e1ec3068bcebd224b215cc53cefb71c70ec88f765d3dda38c1605fa
-  data.tar.gz: 26265dd2d7e18b24d6649d535b2546c42ea41404238e15117f65045621da1f31
+  metadata.gz: 26ed59a6dae9c41b8fe6a3aa7b24f7ba2cc430696acfa061094c2e1e690a437d
+  data.tar.gz: 7bc89adfb0d48a8c4cfed55c1633771fcf57889e56e67efcbe2cc4f5d4ab5d7c
 SHA512:
-  metadata.gz: c7cd7a72afe17f051550b28fd8b3de74227d38c1ef02e24a62242d355efcff1bf183103188b365201cec19e2506d1a2c3d6cbfb7c3e288e78abd612d08fc1174
-  data.tar.gz: 3749db0be1011a9998684e5f9d66a1d990a97233e892581655136b576916e3becee978bc17002b3617b2536401339ba0ed4ce6c0d107e5c5a65035f0f3f997af
+  metadata.gz: a0df963608fd632710848105a954214aa5c6fbc33a7a789230d372567d0de534f5320e82ce2cd0d4b5854b960528faa5f1ca64962e2ed5c7f56219b19a0bfcb4
+  data.tar.gz: 7817262789b374aa634ac3c5087d88c3e9672bcb50b783928c2bf349461278c41da2b4b9702c062b4bed7116940b1eea4e584cd67f6ba72d1774a9286be53fcb

data/CHANGELOG.md

@@ -1,4 +1,17 @@
-## [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
+
+- Breaking: Add commands to the CLI: `version`, `list-worklows`, `duration-history`
 
 ## [0.1.1] - 2023-06-01
 

data/Gemfile.lock

@@ -1,8 +1,10 @@
 PATH
   remote: .
   specs:
-    ghamma (0.1.1)
+    ghamma (0.3.0)
+      dry-cli
       http
+      tty-progressbar
 
 GEM
   remote: https://rubygems.org/
@@ -12,6 +14,7 @@ GEM
     ast (2.4.2)
     domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
+    dry-cli (1.0.0)
     ffi (1.15.5)
     ffi-compiler (1.0.1)
       ffi (>= 1.0.0)
@@ -66,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/README.md

@@ -13,17 +13,43 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ## Usage
 
-TODO: Write usage instructions here
+### Authentication
+
+The Github workflows API requires an authenticated user, even for public repos.
+To use this tool, you will need a
+[Github API Token](https://docs.github.com/en/rest/overview/authenticating-to-the-rest-api#authenticating-with-a-personal-access-token)
+with at least `read` access to the repo you want to look at.
+
+Once you have that, make it available.
+
+```
+$ export GH_TOKEN="YOUR_API_TOKEN"
+```
+
+Then fetch the list of available workflows for the repo. The name will be necessary in the next step.
+
+```
+$ ghamma list-workflows tony-rowan ghamma
+Found 1 workflows
+Ruby
+```
+
+Then fetch a CSV of the durations of the latest workflow runs.
+
+```
+$ ghamma duration-history tony-rowan ghamma Ruby
+Date,Duration
+2023-06-01T15:44:49Z,21000
+2023-06-01T15:37:21Z,17000
+2023-06-01T15:35:16Z,23000
+2023-06-01T15:31:33Z,19000
+```
 
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test-unit` to run the tests.
 You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update
-the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the
-version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/tony-rowan/ghamma. This project is

data/exe/ghamma

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
 
-require 'ghamma'
+require "ghamma"
 
-Ghamma::Cli.new.print_workflow_duration_metrics
+Dry::CLI.new(Ghamma::CLI).call

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,80 +1,13 @@
-require "csv"
-require "http"
+require "dry/cli"
 
-module Ghamma
-  class Cli
-
-    BASE_URL = "https://api.github.com".freeze
-    OWNER = ARGV[0].freeze
-    REPOSITORY = ARGV[1].freeze
-
-    def api_url(resource)
-      "#{BASE_URL}#{resource}"
-    end
-
-    def get(resource, params = {})
-      response = HTTP
-        .auth("Bearer #{ENV["GH_TOKEN"]}")
-        .get(api_url(resource), params: params)
-        .body
-      JSON.parse(response)
-    end
-
-    def fetch_workflows
-      response = get "/repos/#{OWNER}/#{REPOSITORY}/actions/workflows"
-      response["workflows"].map { |json| {id: json["id"], name: json["name"]} }.tap do |workflows|
-        puts "Found #{workflows.size} workflows"
-      end
-    end
-
-    def fetch_workflows_with_runs
-      fetch_workflows.map do |workflow|
-        response = get "/repos/#{OWNER}/#{REPOSITORY}/actions/workflows/#{workflow[:id]}/runs",
-          {per_page: 100, status: "success", exclude_pull_requests: true, created: ">2023-05-01"}
-        puts "Fetched runs for #{workflow[:name]}"
+require_relative "./cli/version"
+require_relative "./cli/duration"
 
-        next if response["total_count"].zero?
-
-        {
-          id: workflow[:id],
-          name: workflow[:name],
-          runs: response["workflow_runs"].map { |json| {id: json["id"], date: json["created_at"]} }
-        }
-      end.compact
-    end
-
-    def fetch_workflow_duration_metrics
-      fetch_workflows_with_runs.map do |workflow|
-        runs_with_timing = workflow[:runs].map do |workflow_run|
-          response = get "/repos/#{OWNER}/#{REPOSITORY}/actions/runs/#{workflow_run[:id]}/timing"
-
-          {
-            duration: response["run_duration_ms"],
-            date: workflow_run[:date]
-          }
-        end
-
-        puts "Fetched timings for #{workflow[:name]}"
-
-        {
-          name: workflow[:name],
-          runs: runs_with_timing
-        }
-      end
-    end
+module Ghamma
+  module CLI
+    extend Dry::CLI::Registry
 
-    def print_workflow_duration_metrics
-      fetch_workflow_duration_metrics.each do |workflow_metrics|
-        puts workflow_metrics[:name]
-        metrics_table = CSV.generate do |csv|
-          csv << ["Date", "Duration"]
-          workflow_metrics[:runs].each do |metric_datum|
-            csv << [metric_datum[:date], metric_datum[:duration]]
-          end
-        end
-        puts metrics_table
-        puts
-      end
-    end
+    register "version", Version, aliases: ["v", "-v", "--version"]
+    register "duration", Duration
   end
 end

data/lib/ghamma/github_api_client.rb

@@ -0,0 +1,61 @@
+require "http"
+
+module Ghamma
+  class GithubApiClient
+    BASE_URL = "https://api.github.com".freeze
+
+    def initialize(owner:, repo:, token:)
+      @repo_base_url = "#{BASE_URL}/repos/#{owner}/#{repo}"
+      @authorization_header = "Bearer #{token}"
+    end
+
+    def fetch_workflow_duration_history(workflow_id, since, progressbar)
+      pages = 2 # enough to do the first loop
+      page = 1
+      timings = []
+
+      while page <= pages
+        since_param = ">#{since}" if since
+
+        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")
+
+          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
+
+    attr_reader :repo_base_url, :authorization_header
+
+    def get(resource, params = {})
+      HTTP
+        .auth(authorization_header)
+        .get("#{repo_base_url}/actions#{resource}", params: params)
+        .parse
+    end
+  end
+end

data/lib/ghamma/version.rb

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

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: ghamma
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  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
+  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: http
   requirement: !ruby/object:Gem::Requirement
@@ -24,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
@@ -85,6 +113,9 @@ 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
 homepage: https://github.com/tony-rowan/ghamma