cloud-platform-repository-checker 1.0.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cea73244ce641f36e0e876f49e029291701ef1a807ac7b15813ee3af2bbfdfdf
-  data.tar.gz: dd501f909e92abc15998aac96f50f02631841b2125a5a1ee69461de7cd16bce3
+  metadata.gz: 3f05e40d9433c30d78cd29862228c8b3da6fa23cc57390595ecc9bd8e389d73d
+  data.tar.gz: 567a2f1ff63266369bd6aabca971ff679b1021af6766228e19ab825fe34aa7ad
 SHA512:
-  metadata.gz: 6c8f39c52acf21550017c6ef927776c9caebafdcf23fecf6444172c7a2040f1399d088cdb2f7e1f1c61bd90f3e4ea62673a4b80f9bb3a6d29287c00fd59a54bd
-  data.tar.gz: d73713682bee77353203f16e226d94b333fe503524957d89bd2f280e31c65a601c1a5f071ae4777936e87b664427010a6ebf86ffa4e0f4000bc11492fb91ac88
+  metadata.gz: c72bc3a0990b27069e130ff6a7469779449e5893c51d1be1671a0057262a56e2ef45952e174c5787ee4131ee296a8f67e556a693500c411828c9e9bc8c81b9d9
+  data.tar.gz: 9af549c15131b5914b0691ebebc0d3eff7c3dbccbb2aa8480717a9d68c6f31f7fcab037ca55764a5d8bc76b6c557cf9c8f1ec96dc964f6dfe03be24e4b7d050e

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

@@ -5,7 +5,6 @@
 # do/don't comply with our team-wide standards for how github repositories
 # should be configured.
 
-require "bundler/setup"
 require "json"
 require "net/http"
 require "uri"

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,7 +1,7 @@
 class RepositoryReport < GithubGraphQlClient
   attr_reader :organization, :repo_name, :team
 
-  MASTER = "master"
+  MAIN_BRANCH = "main"
   ADMIN = "admin"
   PASS = "PASS"
   FAIL = "FAIL"
@@ -23,6 +23,7 @@ class RepositoryReport < GithubGraphQlClient
     {
       organization: organization,
       name: repo_name,
+      default_branch: default_branch,
       url: repo_url,
       status: status,
       report: all_checks_result
@@ -45,7 +46,8 @@ class RepositoryReport < GithubGraphQlClient
 
   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 +83,9 @@ class RepositoryReport < GithubGraphQlClient
           owner {
             login
           }
+          defaultBranchRef {
+            name
+          }
           branchProtectionRules(first: 50) {
             edges {
               node {
@@ -98,11 +103,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 +122,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.2
+  version: 1.3.0
 platform: ruby
 authors:
 - David Salgado
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-14 00:00:00.000000000 Z
+date: 2020-06-23 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