puppet-community-rangefinder-webhook 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0809e37af3ecb6e28e1a5b4dcfe4e2e70e82cf3259b5c066f57eeb1f950ad737'
-  data.tar.gz: 9056ddf1b0ffe4f7227e37634aab33c37f5e64833ca61b7699368033ac45cb2b
+  metadata.gz: 319aee1e86528e1bbb04db33413c8bbcb80bc98cbffa6d73ad1f9b9eca25ae3e
+  data.tar.gz: 22cea689b62bfe35abc5118763c1a5c17ca34a9ee97776a1a7561070429d9f86
 SHA512:
-  metadata.gz: 778fc282d724c156e20278de341d9fb6436ede49d5f2b835559b32fe6557002d4c3a9fedb6479889b45c120bc619a47f6f51ddec3dfeeaf49f619593b39e23d5
-  data.tar.gz: 13e5d89eb483f393d696e8ce8095b95535858ca689bd814aea531b58b5dcfd0daf7c307f05554df4d02639df759032ed307b291604b844d5c93df416279ea352
+  metadata.gz: ae34ea922dae618cf9cfbc621ec42cd2b91f1f5d97e808ed56bd692737d2358fed6c24fa410db58223a853a6b860d8d87658245a5cbfc778f43d9d9724d9528b
+  data.tar.gz: 2eebbfd33d9544e40213c8ce8aa77a936e2ecd9a737f612b3f5e84a2dd53cb45695ac852d9a3845ee64d136e3457311ae023f648ca2e21e2b632bc527a04db71

data/README.md

@@ -5,9 +5,13 @@ file changes. This GitHub integration allows us to tie it to pull requests
 and provide impact prediction reports as comments when a PR is filed.
 
 It's still fairly young in its development, so please don't hesitate to
-file issues either here or on the 
+file issues either here or on the
 [Rangefinder tool](https://github.com/puppetlabs/puppet-community-rangefinder) itself.
 
+See my [blog post](https://binford2k.com/2020/04/30/downstream-impact-of-pull-requests/)
+for more information on this tool.
+
+
 ## Installation
 
 1. Visit its [GitHub app page](https://github.com/apps/puppet-community-rangefinder).
@@ -18,14 +22,54 @@ file issues either here or on the
 ![install app](public/install_app.png)
 ![select repos](public/select_repos.png)
 
+
+## Running your own server
+
+This is a fairly complex configuration. You'll need to register both Google Cloud
+and GitHub apps, and configure Rangefinder itself.
+
+* Register a new GitHub app following the instructions at:
+    * https://developer.github.com/apps/building-github-apps/creating-a-github-app/
+* Generate a new GitHub private key:
+    * https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/
+* Create a new Google Cloud service account:
+    * https://cloud.google.com/docs/authentication/getting-started
+
+Use that information to generate your configuration file. The `:gcloud` key will
+be passed directly through to the [Rangefinder config](https://github.com/puppetlabs/puppet-community-rangefinder#configuration).
+If you're using the official Puppet public BigQuery dataset, then you should use
+the values provided in the example below.
+
+The configuration file location defaults to the first found of
+
+1. `~/.rangefinder.conf`
+2. `/etc/rangefinder/config.yaml`
+
+### Example configuration:
+
+``` yaml
+---
+:gcloud:
+  :dataset: community
+  :project: dataops-puppet-public-data
+  :keyfile: <your service account credentials>
+:github:
+  :app_identifier: <your app id>
+  :private_key_file: <your private key file>
+  :webhook_secret: <your webhook secret>
+```
+
+
 ## Limitations
 
 This is super early in development and has not yet been battle tested.
 
+
 ## Disclaimer
 
 I take no liability for the use of this tool.
 
+
 Contact
 -------
 

data/bin/rangefinder-webhook

@@ -64,14 +64,14 @@ optparse = OptionParser.new { |opts|
         exit
     end
 
-      # Another typical switch to print the version.
-      opts.on_tail("--version", "Show version") do
-        require 'rangefinder/webhook/version'
+    # Another typical switch to print the version.
+    opts.on_tail("--version", "Show version") do
+      require 'rangefinder/webhook/version'
 
-        puts "Rangefinder: #{Rangefinder::VERSION}"
-        puts "Webhook Server: #{Rangefinder::Webhook::VERSION}"
-        exit
-      end
+      puts "Rangefinder: #{Rangefinder::VERSION}"
+      puts "Webhook Server: #{Rangefinder::Webhook::VERSION}"
+      exit
+    end
 }
 optparse.parse!
 
@@ -80,10 +80,17 @@ options       = defaults.merge(config.merge(options))
 $logger       = Logger.new(options[:logfile])
 $logger.level = loglevel
 
-options[:github][:private_key_file] = File.expand_path(options[:github][:private_key_file])
-
-if ssl_opts[:cert_chain_file] and ssl_opts[:private_key_file]
-  options[:ssl] = true
+unless options.include? :github
+  url = 'https://developer.github.com/apps/building-github-apps/creating-a-github-app/'
+  raise "Please register a new GitHub app and configure Rangefinder. See #{url}"
+end
+unless options[:github].include? :private_key_file
+  url = 'https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/'
+  raise "Please generate a new GitHub private key. See #{url}"
+end
+unless options.include? :gcloud
+  url = 'https://cloud.google.com/docs/authentication/getting-started'
+  raise "Please create a new Google Cloud service account and configure Rangefinder. See #{url}"
 end
 
 # These options should either both be nil or both be Strings
@@ -91,6 +98,12 @@ unless ssl_opts[:cert_chain_file].class == ssl_opts[:private_key_file].class
   raise 'You must specify both the certificate and key file!'
 end
 
+if ssl_opts[:cert_chain_file] and ssl_opts[:private_key_file]
+  options[:ssl] = true
+end
+
+options[:github][:private_key_file] = File.expand_path(options[:github][:private_key_file])
+
 if ARGV.first == 'shell'
   require 'pry'
   binding.pry

data/lib/rangefinder/webhook.rb

@@ -53,7 +53,10 @@ class Rangefinder::Webhook < Sinatra::Base
     when 'pull_request'
       case @payload['action']
       when 'opened', 'reopened'
-        scan_for_impact(@payload)
+        # spawn a worker thread so we can return immediately
+        Thread.new do
+          scan_for_impact(@payload)
+        end
       else
         $logger.info "Unhandled PR action: #{@payload['action']}"
       end

data/lib/rangefinder/webhook/version.rb

@@ -1,5 +1,5 @@
-require 'rangefinder/version'
+require 'rangefinder/version' # this is the Rangefinder version, not the Webhook!
 class Rangefinder::Webhook
-  VERSION = '0.0.5'
+  VERSION = '0.0.6'
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-community-rangefinder-webhook
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Ben Ford
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-28 00:00:00.000000000 Z
+date: 2020-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra