cloud-platform-repository-checker 1.0.3 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2b4aca4d981216824e51df4da42c15698739e92113d4d20c942a8e1c6ee2351
-  data.tar.gz: 222a26a71b7f78e4ae6b14b725b50310513f0bab1511a93ffb93fdf56b0431fb
+  metadata.gz: 349475811494cf5ed087f35cdc0a24f1ef623aed8c35460755795d4dc2d4b3ce
+  data.tar.gz: 6ccc18f29bdc90fcf4f5e3f3bdbbf8f2a4a12e6d4b0591de47ceeeeae86179d1
 SHA512:
-  metadata.gz: b2ab3ded011bed4820ac322e71264699c82e147bf73e0f4a5c0b19c1fb6328c69d719f5bbda0b80c8f4db7db5a4a434cd8cb3913d5c388c8988eeac5708c35c7
-  data.tar.gz: c40911cafba83133022983f040cd3e2f8ba20e4d604a90220652853faa0295dce1928196f1bcf61908da1171db2fe4cfa83705f8233b39e78ca49b09f7babb5f
+  metadata.gz: 816eb3fa94959c00289745126c149fde28b7b857cc8c106636a0c61b18f91b1cd4291ec8b9c9aed72ad5d91b797b08879dd6e4d0a92bb257b093fc2105d013f1
+  data.tar.gz: fe518adc7d36d267ae86a48e1183e9b6194a325d98e21e839f87bd516cbb7b85ece38fb8c05cbd2899055ff445d3d7fbc5f58b74e6b8cfbad3ba592534a64283

data/Gemfile

@@ -8,4 +8,5 @@ gem "octokit"
 
 group :development do
   gem "pry-byebug"
+  gem "rspec"
 end

data/Gemfile.lock

@@ -5,6 +5,7 @@ GEM
       public_suffix (>= 2.0.2, < 5.0)
     byebug (11.1.3)
     coderay (1.1.2)
+    diff-lcs (1.3)
     faraday (1.0.1)
       multipart-post (>= 1.2, < 3)
     method_source (1.0.0)
@@ -19,6 +20,19 @@ GEM
       byebug (~> 11.0)
       pry (~> 0.13.0)
     public_suffix (4.0.5)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
     sawyer (0.8.2)
       addressable (>= 2.3.5)
       faraday (> 0.8, < 2.0)
@@ -29,6 +43,7 @@ PLATFORMS
 DEPENDENCIES
   octokit
   pry-byebug
+  rspec
 
 BUNDLED WITH
    2.1.2

data/bin/check.rb

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+
+# Script to list repositories in the ministryofjustice organisation whose names
+# match a regular expression, and output a JSON report of how well they
+# do/don't comply with our team-wide standards for how github repositories
+# should be configured.
+
+require "json"
+require "net/http"
+require "uri"
+require "octokit"
+
+require_relative "../lib/github_graph_ql_client"
+require_relative "../lib/repository_lister"
+require_relative "../lib/repository_report"
+
+############################################################
+
+params = {
+  organization: ENV.fetch("ORGANIZATION"),
+  regexp: Regexp.new(ENV.fetch("REGEXP")),
+  team: ENV.fetch("TEAM"),
+  github_token: ENV.fetch("GITHUB_TOKEN")
+}
+
+repo_name = ARGV.shift
+pp RepositoryReport.new(params.merge(repo_name: repo_name)).fetch_repo_data

data/bin/cloud-platform-repository-checker

@@ -16,8 +16,15 @@ require_relative "../lib/repository_report"
 
 ############################################################
 
+# Exceptions are repos which are allowed to break the rules.
+# e.g. a repo to which compiled html files for a github pages
+# site can't implement branch protection, but we don't want it
+# to show up as an error
+exceptions = ENV["REPO_EXCEPTIONS"].to_s.split(" ")
+
 params = {
   organization: ENV.fetch("ORGANIZATION"),
+  exceptions: exceptions,
   regexp: Regexp.new(ENV.fetch("REGEXP")),
   team: ENV.fetch("TEAM"),
   github_token: ENV.fetch("GITHUB_TOKEN")

data/bin/list-master-repos.rb

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+
+# Script to list repositories in the ministryofjustice organisation whose names
+# match a regular expression, and whose default branch is "master"
+
+require "json"
+require "net/http"
+require "uri"
+require "octokit"
+
+require_relative "../lib/github_graph_ql_client"
+require_relative "../lib/repository_lister"
+require_relative "../lib/repository_report"
+
+############################################################
+
+params = {
+  organization: ENV.fetch("ORGANIZATION"),
+  regexp: Regexp.new(ENV.fetch("REGEXP")),
+  team: ENV.fetch("TEAM"),
+  github_token: ENV.fetch("GITHUB_TOKEN")
+}
+
+repositories = RepositoryLister.new(params)
+  .repository_names
+  .inject([]) do |arr, repo_name|
+    report = RepositoryReport.new(params.merge(repo_name: repo_name)).report
+    arr << report
+end
+
+repositories.filter { |report| report.fetch(:default_branch) == "master" }.each { |report| puts report.fetch(:name) }

data/lib/repository_lister.rb

@@ -12,7 +12,7 @@ class RepositoryLister < GithubGraphQlClient
   # Returns a list of repository names which match `regexp`
   def repository_names
     list_repos
-      .filter { |repo| repo["name"] =~ regexp }
+      .select { |repo| repo["name"] =~ regexp }
       .map { |repo| repo["name"] }
   end
 

data/lib/repository_report.rb

@@ -1,13 +1,14 @@
 class RepositoryReport < GithubGraphQlClient
-  attr_reader :organization, :repo_name, :team
+  attr_reader :organization, :exceptions, :repo_name, :team
 
-  MASTER = "master"
+  MAIN_BRANCH = "main"
   ADMIN = "admin"
   PASS = "PASS"
   FAIL = "FAIL"
 
   def initialize(params)
     @organization = params.fetch(:organization)
+    @exceptions = params.fetch(:exceptions) # repos which are allowed to break the rules
     @repo_name = params.fetch(:repo_name)
     @team = params.fetch(:team)
     super(params)
@@ -23,6 +24,7 @@ class RepositoryReport < GithubGraphQlClient
     {
       organization: organization,
       name: repo_name,
+      default_branch: default_branch,
       url: repo_url,
       status: status,
       report: all_checks_result
@@ -40,12 +42,17 @@ class RepositoryReport < GithubGraphQlClient
   end
 
   def status
-    all_checks_result.values.all? ? PASS : FAIL
+    if exceptions.include?(repo_name)
+      PASS
+    else
+      all_checks_result.values.all? ? PASS : FAIL
+    end
   end
 
   def all_checks_result
     @all_checks_result ||= {
-      has_master_branch_protection: has_master_branch_protection?,
+      default_branch_main: default_branch_main?,
+      has_main_branch_protection: has_main_branch_protection?,
       requires_approving_reviews: has_branch_protection_property?("requiresApprovingReviews"),
       requires_code_owner_reviews: has_branch_protection_property?("requiresCodeOwnerReviews"),
       administrators_require_review: has_branch_protection_property?("isAdminEnforced"),
@@ -81,6 +88,9 @@ class RepositoryReport < GithubGraphQlClient
           owner {
             login
           }
+          defaultBranchRef {
+            name
+          }
           branchProtectionRules(first: 50) {
             edges {
               node {
@@ -98,11 +108,15 @@ class RepositoryReport < GithubGraphQlClient
     ]
   end
 
+  def default_branch
+    repo_data.dig("data", "repository", "defaultBranchRef", "name")
+  end
+
   def is_team_admin?
     client = Octokit::Client.new(access_token: github_token)
 
-    client.repo_teams([organization, repo_name].join("/")).filter do |team|
-      team[:name] == team && team[:permission] == ADMIN
+    client.repo_teams([organization, repo_name].join("/")).select do |t|
+      t[:name] == team && t[:permission] == ADMIN
     end.any?
   rescue Octokit::NotFound
     # This happens if our token does not have permission to view repo settings
@@ -113,11 +127,15 @@ class RepositoryReport < GithubGraphQlClient
     @rules ||= repo_data.dig("data", "repository", "branchProtectionRules", "edges")
   end
 
-  def has_master_branch_protection?
+  def default_branch_main?
+    default_branch == MAIN_BRANCH
+  end
+
+  def has_main_branch_protection?
     requiring_branch_protection_rules do |rules|
 
       rules
-        .filter { |edge| edge.dig("node", "pattern") == MASTER }
+        .select { |edge| edge.dig("node", "pattern") == MAIN_BRANCH }
         .any?
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloud-platform-repository-checker
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.4.0
 platform: ruby
 authors:
 - David Salgado
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-14 00:00:00.000000000 Z
+date: 2020-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: octokit
@@ -27,7 +27,9 @@ dependencies:
 description: 
 email: platforms@digital.justice.gov.uk
 executables:
+- check.rb
 - cloud-platform-repository-checker
+- list-master-repos.rb
 extensions: []
 extra_rdoc_files:
 - README.md
@@ -36,7 +38,9 @@ files:
 - Gemfile.lock
 - LICENSE
 - README.md
+- bin/check.rb
 - bin/cloud-platform-repository-checker
+- bin/list-master-repos.rb
 - env.example
 - lib/github_graph_ql_client.rb
 - lib/repository_lister.rb