github_snap_builder 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3ab5c0008844156c54ae4bdca678c75f5c5834b985e5d22dfbfeb3798d6d592d
+  data.tar.gz: 1920c78ec7f5d9ae27d276dc4e9ca6a784a81f079a72dbc7d70c75aafab65cbd
+SHA512:
+  metadata.gz: da93b02af100acc6fd4c5cae802e2edd0112cf03ac66207895d560a63668e4da96eb77e0e423adfc92ecfa5b01e1540fa98f59d0616d4bda18c85e83bdab34f9
+  data.tar.gz: 13cdd5e0a397785a243a75cf4dc46e0141552ce57c3575707585fa37d1714f2c4feabdf96034fd910cf62f575053a744e912f621e257c9cb95f931a094f22db4

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem
+snap/.snapcraft/
+parts
+stage/
+prime/
+*.snap
+.vscode/

data/.ruby-gemset

@@ -0,0 +1 @@
+snap-builder

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.6.1

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.1
+before_install: gem install bundler -v 2.0.1

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in github_snap_builder.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,64 @@
+PATH
+  remote: .
+  specs:
+    github_snap_builder (0.1.0)
+      docker-api (~> 1.34)
+      jwt (~> 2.1)
+      octokit (~> 4.0)
+      rugged (~> 0.0)
+      sinatra (~> 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    docker-api (1.34.2)
+      excon (>= 0.47.0)
+      multi_json
+    excon (0.62.0)
+    faraday (0.15.4)
+      multipart-post (>= 1.2, < 3)
+    jwt (2.1.0)
+    metaclass (0.0.4)
+    mocha (1.8.0)
+      metaclass (~> 0.0.1)
+    multi_json (1.13.1)
+    multipart-post (2.0.0)
+    mustermann (1.0.3)
+    octokit (4.13.0)
+      sawyer (~> 0.8.0, >= 0.5.3)
+    power_assert (1.1.3)
+    public_suffix (3.0.3)
+    rack (2.0.6)
+    rack-protection (2.0.5)
+      rack
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rake (12.3.2)
+    rugged (0.27.7)
+    sawyer (0.8.1)
+      addressable (>= 2.3.5, < 2.6)
+      faraday (~> 0.8, < 1.0)
+    sinatra (2.0.5)
+      mustermann (~> 1.0)
+      rack (~> 2.0)
+      rack-protection (= 2.0.5)
+      tilt (~> 2.0)
+    test-unit (3.3.0)
+      power_assert
+    tilt (2.0.9)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  github_snap_builder!
+  mocha (~> 1.0)
+  rack-test (~> 1.0)
+  rake (~> 12.3)
+  test-unit (~> 3.2)
+
+BUNDLED WITH
+   2.0.1

data/README.md

@@ -0,0 +1,35 @@
+# GithubSnapBuilder
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/github_snap_builder`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'github_snap_builder'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install github_snap_builder
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/github_snap_builder.

data/Rakefile

@@ -0,0 +1,11 @@
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+	if ENV['TEST'].nil? or ENV['TEST'].empty?
+		t.pattern = "tests/**/*_test.rb"
+	else
+		t.pattern = ENV['TEST']
+	end
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "github_snap_builder"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/github_snap_builder

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'github_snap_builder/server'
+
+GithubSnapBuilder::Application.run!

data/bin/github_snap_builder_config_validator

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+require 'github_snap_builder/config'
+
+if ARGV.length != 1
+	puts "Usage:"
+	puts "  github_snap_builder_config_validator <config file>"
+	exit 0
+end
+
+config = GithubSnapBuilder::Config.new(File.read(ARGV[0]))
+
+begin
+	config.validate
+rescue GithubSnapBuilder::ConfigurationError => e
+	abort e.message
+end

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/configure

@@ -0,0 +1,20 @@
+#!/bin/sh -e
+
+if [ "$(id -u)" -ne 0 ]; then
+	echo "This utility needs to run as root"
+	exit 1
+fi
+
+tmp_config="$(mktemp)"
+cp "$SNAP_BUILDER_CONFIG" "$tmp_config"
+
+editor "$tmp_config"
+while ! "$SNAP/bin/ruby" "$SNAP/bin/github_snap_builder_config_validator" "$tmp_config"; do
+	echo "Press [ENTER] to try again"
+	read _
+	editor "$tmp_config"
+done
+
+mv "$tmp_config" "$SNAP_BUILDER_CONFIG"
+
+snapctl restart github-snap-builder.github-snap-builder

data/github_snap_builder.gemspec

@@ -0,0 +1,45 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "github_snap_builder/version"
+
+Gem::Specification.new do |spec|
+	spec.name          = "github_snap_builder"
+	spec.version       = GithubSnapBuilder::VERSION
+	spec.authors       = ["Kyle Fazzari"]
+	spec.email         = ["kyrofa@ubuntu.com"]
+
+	spec.summary       = "Github app that builds and releases snaps for each pull request."
+	spec.homepage      = "https://github.com/kyrofa/github-snap-builder"
+	spec.license       = "GPL-3.0"
+
+	# Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+	# to allow pushing to a single host or delete this section to allow pushing to any host.
+	if spec.respond_to?(:metadata)
+		spec.metadata["homepage_uri"] = spec.homepage
+		spec.metadata["source_code_uri"] = spec.homepage
+	else
+		raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+	end
+
+	# Specify which files should be added to the gem when it is released.
+	# The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+	spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+		`git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|snap)/}) }
+	end
+	spec.executables   << "github_snap_builder"
+	spec.executables   << "github_snap_builder_config_validator"
+	spec.require_paths = ["lib"]
+
+	spec.add_dependency 'sinatra', '~> 2.0'
+	spec.add_dependency 'jwt', '~> 2.1'
+	spec.add_dependency 'octokit', '~> 4.0'
+	spec.add_dependency 'rugged', '~> 0.0'
+	spec.add_dependency 'docker-api', '~> 1.34'
+
+	spec.add_development_dependency "bundler", "~> 2.0"
+	spec.add_development_dependency 'test-unit', '~> 3.2'
+	spec.add_development_dependency 'rack-test', '~> 1.0'
+	spec.add_development_dependency 'mocha', '~> 1.0'
+	spec.add_development_dependency 'rake', '~> 12.3'
+end

data/lib/github_snap_builder/builder_implementations/docker.rb

@@ -0,0 +1,87 @@
+require 'date'
+require 'shellwords'
+require 'docker'
+require 'github_snap_builder'
+
+module GithubSnapBuilder
+	class DockerBuilder
+		def initialize(logger, base)
+			@logger = logger
+			@base = base
+
+			begin
+				Docker.validate_version!
+			rescue Excon::Error::Socket
+				raise DockerVersionError
+			end
+		end
+
+		def build(project_directory)
+			# Snapcraft will detect if it's in a docker container and default to
+			# destructive mode.
+			run(['sh', '-c', "apt update -qq && snapcraft"], {
+				'Env' => ['SNAPCRAFT_MANAGED_HOST=yes'],
+				'WorkingDir' => '/snapcraft',
+				'HostConfig' => {
+					'Binds' => ["#{project_directory}:/snapcraft"],
+					'AutoRemove' => true,
+				}
+			})
+		end
+
+		def release(snap_path, token, channel)
+			run(['sh', '-c', "snapcraft login --with /token && snapcraft push #{File.basename(snap_path).shellescape} --release=#{channel.shellescape}"], {
+				'Env' => ['SNAPCRAFT_MANAGED_HOST=yes'],
+				'WorkingDir' => '/snapcraft',
+				'HostConfig' => {
+					'Binds' => ["#{File.dirname(snap_path)}:/snapcraft"],
+					'AutoRemove' => true,
+				}
+			}) do |container|
+				container.store_file("/token", token)
+			end
+		end
+
+		private
+
+		def run(command, options)
+			# Grab the image for this base
+			@logger.info 'Fetching image...'
+			image = get_image(@base)
+			options = {'Image' => image.id, 'Cmd' => command}.merge(options)
+
+			begin
+				# Create a new container
+				@logger.info 'Provisioning...'
+				container = Docker::Container.create options
+
+				# Give called the change to mess with container before running
+				# anything
+				yield container if block_given?
+
+				# Fire up the container and stream its logs
+				@logger.info 'Firing up...'
+				container.tap(&:start).attach({}, {read_timeout: 600}) do |stream, chunk|
+					if stream == :stdout
+						@logger.info chunk
+					else
+						@logger.error chunk
+					end
+				end
+
+				if container.wait()['StatusCode'] != 0
+					@logger.error "Command exited non-zero: aborting"
+					raise DockerRunError, command
+				end
+			ensure
+				# This shouldn't be necessary given the AutoRemove option, but it's
+				# easy to ensure.
+				container.delete(force: true) unless container.nil?
+			end
+		end
+
+		def get_image(base)
+			Docker::Image.create('fromImage' => "kyrofa/github-snap-builder:#{base}")
+		end
+	end
+end

data/lib/github_snap_builder/config.rb

@@ -0,0 +1,143 @@
+require 'yaml'
+require 'github_snap_builder'
+require 'github_snap_builder/snap_builder'
+
+module GithubSnapBuilder
+	class Config
+		def initialize(config_file_contents)
+			@config = YAML.safe_load(config_file_contents) || {}
+		end
+
+		def github_webhook_secret
+			@config['github_webhook_secret']
+		end
+
+		def github_app_id
+			@config['github_app_id']
+		end
+
+		def github_app_private_key
+			@config['github_app_private_key']
+		end
+
+		def build_type
+			@config['build_type']
+		end
+
+		def port
+			@config.fetch('port', 3000)
+		end
+
+		def bind
+			@config.fetch('bind', '0.0.0.0')
+		end
+
+		def repos
+			@repos ||= initialize_repos
+		end
+
+		def repos_include?(repo_name)
+			@config.fetch('repos', {}).include? repo_name
+		end
+
+		def repo(repo_name)
+			repos.each do | repo |
+				if repo.name == repo_name
+					return repo
+				end
+			end
+		end
+
+		def validate
+			if @config.nil? or @config.empty?
+				raise ConfigurationError, "Config seems completely empty"
+			end
+
+			if github_webhook_secret.nil? || !github_webhook_secret.is_a?(String) || github_webhook_secret.empty?
+				raise ConfigurationFieldError, "github_webhook_secret"
+			end
+
+			if github_app_id.nil? || !github_app_id.is_a?(Integer) || github_app_id == 0
+				raise ConfigurationFieldError, "github_app_id"
+			end
+
+			if github_app_private_key.nil? || !github_app_private_key.is_a?(String) || github_app_private_key.empty?
+				raise ConfigurationFieldError, "github_app_private_key"
+			end
+
+			if build_type.nil? || !build_type.is_a?(String) || build_type.empty? || !SnapBuilder.supported_build_types.include?(build_type)
+				raise ConfigurationFieldError, "build_type"
+			end
+
+			if port.nil? || !port.is_a?(Integer) || port == 0
+				raise ConfigurationFieldError, "port"
+			end
+
+			if bind.nil? || !bind.is_a?(String) || bind.empty?
+				raise ConfigurationFieldError, "bind"
+			end
+		end
+
+		def valid?
+			begin
+				validate
+			rescue ConfigurationError
+				return false
+			end
+
+			begin
+				repos.each do | repo |
+					repo.validate
+				end
+			rescue ConfigurationError
+				return false
+			end
+
+			true
+		end
+
+		private
+
+		def initialize_repos
+			repos = []
+			@config.fetch('repos', {}).each do | name, definition |
+				repos << RepoConfig.new(name, definition)
+			end
+			repos
+		end
+	end
+
+	class RepoConfig
+		attr_reader :name, :channel, :token
+
+		def initialize(name, config)
+			@name = name
+			@channel = config.fetch('channel', 'edge')
+			@token = config['token']
+		end
+
+		def validate
+			if name.nil? || !name.is_a?(String) || name.empty?
+				raise ConfigurationFieldError, "repo name"
+			end
+
+			if channel.nil? || !channel.is_a?(String) || channel.empty?
+				raise ConfigurationFieldError, "#{name}'s channel"
+			end
+
+			if token.nil? || !token.is_a?(String) || token.empty?
+				raise ConfigurationFieldError, "#{name}'s token"
+			end
+		end
+
+		def valid?
+			begin
+				validate
+			rescue ConfigurationError
+				return false
+			end
+
+			true
+		end
+	end
+end