Add some CI

Author: jaymzh

.github/workflows/ci.yml

@@ -0,0 +1,29 @@
+name: Continuous Integration
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  ruby:
+    strategy:
+      fail-fast: false
+      matrix: 3.3
+    runs-on: ubuntu-latest
+    steps:
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+    - name: Setup Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - name: Install dependencies
+      run: bundle install
+    # no tests yet
+    #- name: Run rspec
+    #  run: bundle exec rspec
+    - name: Run chefstyle
+      run: ./scripts/run_chefstyle.sh
+    - name: Run markdownlint
+      run: ./scripts/run_markdownlint.sh

.github/workflows/dco.yml

@@ -0,0 +1,17 @@
+name: DCO Check
+on: [pull_request]
+
+jobs:
+  dco_check_job:
+    runs-on: ubuntu-latest
+    name: DCO Check
+    steps:
+    - name: Get PR Commits
+      uses: tim-actions/get-pr-commits@master
+      id: 'get-pr-commits'
+      with:
+        token: ${{ secrets.GITHUB_TOKEN }}
+    - name: DCO Check
+      uses: tim-actions/dco@master
+      with:
+        commits: ${{ steps.get-pr-commits.outputs.commits }}

.sugarjar.yml

@@ -0,0 +1,4 @@
+on_push: [lint]
+lint:
+  - scripts/run_chefstyle.sh
+  - scripts/run_markdownlint.sh

Gemfile

@@ -1,6 +1,11 @@
 source "https://rubygems.org"
 
-gem 'sqlite3'
-gem 'octokit'
-gem 'faraday-retry'
-gem 'gruff'
+gem "sqlite3"
+gem "octokit"
+gem "faraday-retry"
+gem "gruff"
+
+group(:development) do
+  gem "chefstyle"
+  gem "mdl"
+end

Gemfile.lock

@@ -3,7 +3,13 @@ GEM
   specs:
     addressable (2.8.7)
       public_suffix (>= 2.0.2, < 7.0)
+    ast (2.4.2)
     bigdecimal (3.1.9)
+    chef-utils (18.6.2)
+      concurrent-ruby
+    chefstyle (2.2.3)
+      rubocop (= 1.25.1)
+    concurrent-ruby (1.3.5)
     faraday (2.12.2)
       faraday-net_http (>= 2.0, < 3.5)
       json
@@ -18,18 +24,53 @@ GEM
       rmagick (>= 5.5)
     histogram (0.2.4.1)
     json (2.10.2)
+    kramdown (2.5.1)
+      rexml (>= 3.3.9)
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
     logger (1.6.6)
+    mdl (0.13.0)
+      kramdown (~> 2.3)
+      kramdown-parser-gfm (~> 1.1)
+      mixlib-cli (~> 2.1, >= 2.1.1)
+      mixlib-config (>= 2.2.1, < 4)
+      mixlib-shellout
+    mixlib-cli (2.1.8)
+    mixlib-config (3.0.27)
+      tomlrb
+    mixlib-shellout (3.3.8)
+      chef-utils
     net-http (0.6.0)
       uri
     observer (0.1.2)
     octokit (9.2.0)
       faraday (>= 1, < 3)
       sawyer (~> 0.9)
+    parallel (1.26.3)
+    parser (3.3.7.1)
+      ast (~> 2.4.1)
+      racc
     pkg-config (1.6.0)
     public_suffix (6.0.1)
+    racc (1.8.1)
+    rainbow (3.1.1)
+    regexp_parser (2.10.0)
+    rexml (3.4.1)
     rmagick (6.1.1)
       observer (~> 0.1)
       pkg-config (~> 1.4)
+    rubocop (1.25.1)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.15.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.38.1)
+      parser (>= 3.3.1.0)
+    ruby-progressbar (1.13.0)
     sawyer (0.9.2)
       addressable (>= 2.3.5)
       faraday (>= 0.17.3, < 3)
@@ -43,6 +84,8 @@ GEM
     sqlite3 (2.6.0-x86_64-darwin)
     sqlite3 (2.6.0-x86_64-linux-gnu)
     sqlite3 (2.6.0-x86_64-linux-musl)
+    tomlrb (2.0.3)
+    unicode-display_width (2.6.0)
     uri (1.0.3)
 
 PLATFORMS
@@ -58,8 +101,10 @@ PLATFORMS
   x86_64-linux-musl
 
 DEPENDENCIES
+  chefstyle
   faraday-retry
   gruff
+  mdl
   octokit
   sqlite3
 

scripts/run_chefstyle.rb

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+bundle exec chefstyle "$@"

scripts/run_markdownlint.sh

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+bundle exec mdl "$@"

src/chef-ci-status.rb

@@ -1,18 +1,17 @@
 #!/usr/bin/env ruby
 
-require 'optparse'
-require 'date'
-require 'yaml'
-require 'octokit'
-require 'set'
-
+require "optparse"
+require "date"
+require "yaml"
+require "octokit"
+require "set"
 
 # Get GitHub token
 def get_github_token
-  config_path = File.expand_path('~/.config/gh/hosts.yml')
+  config_path = File.expand_path("~/.config/gh/hosts.yml")
   if File.exist?(config_path)
     config = YAML.load_file(config_path)
-    return config.dig('github.com', 'oauth_token')
+    return config.dig("github.com", "oauth_token")
   end
   nil
 end
@@ -33,7 +32,7 @@ def get_failed_tests_from_ci(client, options, branches)
       page = 1
 
       loop do
-        runs = client.workflow_runs(repo, workflow.id, branch: branch, status: 'completed', per_page: 100, page: page)
+        runs = client.workflow_runs(repo, workflow.id, branch: branch, status: "completed", per_page: 100, page: page)
         break if runs.workflow_runs.empty?
 
         workflow_runs.concat(runs.workflow_runs)
@@ -42,7 +41,7 @@ def get_failed_tests_from_ci(client, options, branches)
         page += 1
       end
 
-      workflow_runs.sort_by! { |run| run.created_at }
+      workflow_runs.sort_by!(&:created_at)
       last_failure_date = {}
 
       workflow_runs.each do |run|
@@ -55,7 +54,7 @@ def get_failed_tests_from_ci(client, options, branches)
         jobs.each do |job|
           puts "  Checking job: #{job.name} (Status: #{job.conclusion})" if options[:verbose]
 
-          failed_tests[branch][job.name] ||= Set.new if job.conclusion == 'failure'
+          failed_tests[branch][job.name] ||= Set.new if job.conclusion == "failure"
           last_date = last_failure_date[job.name]
 
           if last_date
@@ -66,11 +65,11 @@ def get_failed_tests_from_ci(client, options, branches)
             end
           end
 
-          if job.conclusion == 'failure'
+          if job.conclusion == "failure"
             puts "  -> First failure of #{job.name}" if options[:verbose] && !last_failure_date.key?(job.name)
             failed_tests[branch][job.name] << run_date
             last_failure_date[job.name] = run_date
-          elsif job.conclusion == 'success'
+          elsif job.conclusion == "success"
             last_failure_date.delete(job.name)
           end
         rescue StandardError => e
@@ -93,35 +92,35 @@ def get_failed_tests_from_ci(client, options, branches)
 end
 
 options = {
-  owner: 'chef',
-  repo: 'chef',
-  branches: 'chef-18,main',
+  owner: "chef",
+  repo: "chef",
+  branches: "chef-18,main",
   days: 30,
-  verbose: false
+  verbose: false,
 }
 
 OptionParser.new do |opts|
-  opts.banner = 'Usage: script.rb [options]'
+  opts.banner = "Usage: script.rb [options]"
 
-  opts.on('--owner OWNER', 'GitHub owner/org name') { |v| options[:owner] = v }
-  opts.on('--repo REPO', 'GitHub repository name') { |v| options[:repo] = v }
-  opts.on('--branches BRANCHES', 'Comma-separated list of branches') { |v| options[:branches] = v }
-  opts.on('--days DAYS', Integer, 'Number of days to analyze') { |v| options[:days] = v }
-  opts.on('-v', '--verbose', 'Enable verbose output') { options[:verbose] = true }
+  opts.on("--owner OWNER", "GitHub owner/org name") { |v| options[:owner] = v }
+  opts.on("--repo REPO", "GitHub repository name") { |v| options[:repo] = v }
+  opts.on("--branches BRANCHES", "Comma-separated list of branches") { |v| options[:branches] = v }
+  opts.on("--days DAYS", Integer, "Number of days to analyze") { |v| options[:days] = v }
+  opts.on("-v", "--verbose", "Enable verbose output") { options[:verbose] = true }
 end.parse!
 
 github_token = get_github_token
-raise 'GitHub token not found in ~/.config/gh/hosts.yml' unless github_token
+raise "GitHub token not found in ~/.config/gh/hosts.yml" unless github_token
 
 client = Octokit::Client.new(access_token: github_token)
 
-branches = options[:branches].split(',')
+branches = options[:branches].split(",")
 test_failures = get_failed_tests_from_ci(client, options, branches)
 puts "Days each job was broken in the last #{options[:days]} days:"
 test_failures.each do |branch, jobs|
   puts "\nBranch: #{branch}"
   if jobs.empty?
-    puts '  No job failures found.'
+    puts "  No job failures found."
   else
     jobs.sort.each do |job, dates|
       puts "  #{job}: #{dates.size} days"