cloud-platform-repository-checker 1.0.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 858af448467a05e3a98bba68dac83f8fbc5250b9a9c91a879d60d53b6b78e5c3
-  data.tar.gz: 574109bf4b68682da814f8fbdbffedf80948a0daf2404ee69fe8ffff2003b521
+  metadata.gz: 1e8cf546dab8f2551ca91e723bb23195baa4de9ca433c0b01f5cbd8d62405781
+  data.tar.gz: 36787f13af08b887b4289964411164f0a8a636346f25002ea7d84170e644c257
 SHA512:
-  metadata.gz: 278579fd2a4755ff58fdf4d98131f4c06a0e4e4a1d224e37a616c310fa7944644a118b2a7d26d643f1a4ccbca3d0318272d8491dea43baa7870b58aa85336882
-  data.tar.gz: 7087136847c8a86f75aae37454a65a1bfc9d8b4b200c75fdaf4208ec5748866d6bab2602ac38ab16c599a29a4e3e42cab98047f0bd27e51a13e821c387ffdbd5
+  metadata.gz: 2b04b7f8e2b4d75b273e19d65006a47fd65f5d8ef1c9e3d817c713fb716944686cd596b574deb54970dbda32cfe4387cad0097c525c9005ecaed8e8e12b80adb
+  data.tar.gz: 01a1858cacaba240aa9a1193b39072518a70c7108b148ab0e9de04dd673e0dfa447a0d353f571307235b64083aead7740afad030dafeccf8b044370825c7bf92

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,16 +5,14 @@
 # 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"
 require "octokit"
 
-libdir = File.join(".", File.dirname(__FILE__), "..", "lib")
-require File.join(libdir, "github_graph_ql_client")
-require File.join(libdir, "repository_lister")
-require File.join(libdir, "repository_report")
+require_relative "../lib/github_graph_ql_client"
+require_relative "../lib/repository_lister"
+require_relative "../lib/repository_report"
 
 ############################################################
 

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_BRANCHES = ["main", "master"] # We are changing to use "main" but many repos still use "master" as default branch
   ADMIN = "admin"
   PASS = "PASS"
   FAIL = "FAIL"
@@ -45,7 +45,7 @@ class RepositoryReport < GithubGraphQlClient
 
   def all_checks_result
     @all_checks_result ||= {
-      has_master_branch_protection: has_master_branch_protection?,
+      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"),
@@ -101,8 +101,8 @@ class RepositoryReport < GithubGraphQlClient
   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 +113,11 @@ class RepositoryReport < GithubGraphQlClient
     @rules ||= repo_data.dig("data", "repository", "branchProtectionRules", "edges")
   end
 
-  def has_master_branch_protection?
+  def has_main_branch_protection?
     requiring_branch_protection_rules do |rules|
 
       rules
-        .filter { |edge| edge.dig("node", "pattern") == MASTER }
+        .select { |edge| MAIN_BRANCHES.include?(edge.dig("node", "pattern")) }
         .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.1
+  version: 1.2.0
 platform: ruby
 authors:
 - David Salgado
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-14 00:00:00.000000000 Z
+date: 2020-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: octokit
@@ -27,6 +27,7 @@ dependencies:
 description: 
 email: platforms@digital.justice.gov.uk
 executables:
+- check.rb
 - cloud-platform-repository-checker
 extensions: []
 extra_rdoc_files:
@@ -36,6 +37,7 @@ files:
 - Gemfile.lock
 - LICENSE
 - README.md
+- bin/check.rb
 - bin/cloud-platform-repository-checker
 - env.example
 - lib/github_graph_ql_client.rb