cyclid 0.2.1 → 0.2.2

data/app/cyclid/plugins/api/github/pull_request.rb

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+# Copyright 2016 Liqwyd Ltd.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'octokit'
+
+# Top level module for the core Cyclid code.
+module Cyclid
+  # Module for the Cyclid API
+  module API
+    # Module for Cyclid Plugins
+    module Plugins
+      # Container for the Sinatra related controllers modules
+      module ApiExtension
+        # Github plugin method callbacks
+        module GithubMethods
+          # Handle a Pull Request event
+          module PullRequest
+            # Handle a Github Pull Request event
+            def event_pull_request(config)
+              # Safely load the JSON event data
+              @payload = parse_request_body
+              Cyclid.logger.debug "hook payload=#{@payload.inspect}"
+
+              # Do we know what to do with this action?
+              action = @payload['action'] || nil
+
+              Cyclid.logger.debug "action=#{action}"
+              return true unless action == 'opened' \
+                              or action == 'reopened' \
+                              or action == 'synchronize'
+
+              # Get the list of files in the root of the repository in the
+              # Pull Request branch
+              clone_url = URI(pr_clone_url)
+
+              # Get the authentication key
+              auth_token = find_oauth_token(config, clone_url)
+
+              return_failure(400, "can not find a valid OAuth token for #{clone_url}") \
+                if auth_token.nil?
+
+              # Create an Octokit client
+              @client = Octokit::Client.new(access_token: auth_token)
+
+              # Set the PR to 'pending'
+              @client.create_status(pr_repository, pr_sha, 'pending',
+                                    context: 'Cyclid', description: 'Preparing build')
+
+              # Get the Pull Request
+              tree = @client.tree(pr_repository, pr_sha, recursive: false)
+              Cyclid.logger.debug "tree=#{tree.to_hash}"
+
+              # Find the Cyclid job file (if it exists)
+              job_sha, job_type = find_job_file(tree)
+              Cyclid.logger.debug "job_sha=#{job_sha}"
+
+              if job_sha.nil?
+                @client.create_status(pr_repository, pr_sha, 'error',
+                                      context: 'Cyclid', description: 'No Cyclid job file found')
+
+                return_failure(400, 'not a Cyclid repository')
+              end
+
+              # Get the job file
+              begin
+                job_definition = load_job_file(pr_repository, job_sha, job_type)
+
+                # Insert this repository & branch into the sources
+                #
+                # XXX Could this cause collisions between the existing sources in
+                # the job definition? Not entirely sure what the workflow will
+                # look like.
+                job_sources = job_definition['sources'] || []
+                job_sources << { 'type' => 'git',
+                                 'url' => clone_url.to_s,
+                                 'branch' => pr_ref,
+                                 'token' => auth_token }
+                job_definition['sources'] = job_sources
+
+                Cyclid.logger.debug "sources=#{job_definition['sources']}"
+              rescue StandardError => ex
+                Cyclid.logger.error "failed to retrieve Github Pull Request job: #{ex}"
+
+                @client.create_status(pr_repository, pr_sha, 'error',
+                                      context: 'Cyclid',
+                                      description: "Couldn't retrieve Cyclid job file")
+                return_failure(400, 'not a Cyclid repository')
+              end
+
+              Cyclid.logger.debug "job_definition=#{job_definition}"
+
+              begin
+                # Retrieve the plugin configuration
+                plugins_config = Cyclid.config.plugins
+                github_config = load_github_config(plugins_config)
+
+                ui_url = github_config[:ui_url]
+                linkback_url = "#{ui_url}/#{organization_name}"
+
+                # Inject some useful context data
+                ctx = { gh_event: 'pull_request',
+                        gh_user: pull_request['user']['login'],
+                        gh_ref: pr_ref,
+                        gh_comment: pull_request['body'] }
+
+                callback = GithubCallback.new(auth_token, pr_repository, pr_sha, linkback_url)
+                job_from_definition(job_definition, callback, ctx)
+              rescue StandardError
+                @client.create_status(pr_repository, pr_sha, 'error',
+                                      context: 'Cyclid', description: 'An unknown error occurred')
+
+                return_failure(500, 'job failed')
+              end
+
+              return true
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/app/cyclid/plugins/api/github/push.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+# Copyright 2016 Liqwyd Ltd.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'octokit'
+
+# Top level module for the core Cyclid code.
+module Cyclid
+  # Module for the Cyclid API
+  module API
+    # Module for Cyclid Plugins
+    module Plugins
+      # Container for the Sinatra related controllers modules
+      module ApiExtension
+        # Github plugin method callbacks
+        module GithubMethods
+          # Handle a Pull Request event
+          module Push
+            # Handle a Github Push event
+            def event_push(config)
+              # Safely load the JSON event data
+              @payload = parse_request_body
+              Cyclid.logger.debug "hook payload=#{@payload.inspect}"
+
+              # Get the list of files in the root of the repository in the
+              # push branch
+              clone_url = URI(push_clone_url)
+
+              # Get the authentication key
+              auth_token = find_oauth_token(config, clone_url)
+
+              return_failure(400, "can not find a valid OAuth token for #{clone_url}") \
+                if auth_token.nil?
+
+              # Create an Octokit client
+              @client = Octokit::Client.new(access_token: auth_token)
+
+              # Get the push head
+              tree = @client.tree(push_repository, push_sha, recursive: false)
+              Cyclid.logger.debug "tree=#{tree.to_hash}"
+
+              # Find the Cyclid job file (if it exists)
+              job_sha, job_type = find_job_file(tree)
+              Cyclid.logger.debug "job_sha=#{job_sha}"
+
+              if job_sha.nil?
+                @client.create_status(push_repository, push_sha, 'error',
+                                      context: 'Cyclid', description: 'No Cyclid job file found')
+                return_failure(400, 'not a Cyclid repository')
+              end
+
+              # Get the job file
+              begin
+                job_definition = load_job_file(push_repository, job_sha, job_type)
+
+                # Insert this repository & branch into the sources
+                #
+                # XXX Could this cause collisions between the existing sources in
+                # the job definition? Not entirely sure what the workflow will
+                # look like.
+                job_sources = job_definition['sources'] || []
+                job_sources << { 'type' => 'git',
+                                 'url' => clone_url.to_s,
+                                 'branch' => push_ref,
+                                 'token' => auth_token }
+                job_definition['sources'] = job_sources
+
+                Cyclid.logger.debug "sources=#{job_definition['sources']}"
+              rescue StandardError => ex
+                Cyclid.logger.error "failed to retrieve Github Push job: #{ex}"
+
+                @client.create_status(push_repository, push_sha, 'error',
+                                      context: 'Cyclid',
+                                      description: "Couldn't retrieve Cyclid job file")
+                return_failure(400, 'not a Cyclid repository')
+              end
+
+              Cyclid.logger.debug "job_definition=#{job_definition}"
+
+              begin
+                # Retrieve the plugin configuration
+                plugins_config = Cyclid.config.plugins
+                github_config = load_github_config(plugins_config)
+
+                ui_url = github_config[:ui_url]
+                linkback_url = "#{ui_url}/#{organization_name}"
+
+                # Inject some useful context data
+                ctx = { gh_event: 'push',
+                        gh_user: @payload['sender']['login'],
+                        gh_ref: push_ref,
+                        gh_comment: push_head_commit['message'] }
+
+                callback = GithubCallback.new(auth_token, push_repository, push_sha, linkback_url)
+                job_from_definition(job_definition, callback, ctx)
+              rescue StandardError
+                @client.create_status(push_repository, push_sha, 'error',
+                                      context: 'Cyclid', description: 'An unknown error occurred')
+
+                return_failure(500, 'job failed')
+              end
+
+              return true
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/app/cyclid/plugins/dispatcher/local.rb

@@ -103,7 +103,7 @@ module Cyclid
             @job_record.save!
 
             # Ping the callback status_changed hook, if required
-            @callback.status_changed(@job_id, status) if @callback
+            @callback&.status_changed(@job_id, status)
           end
 
           # Set the JobRecord ended
@@ -114,7 +114,7 @@ module Cyclid
 
           # Ping the callback completion hook, if required
           def completion(success)
-            @callback.completion(@job_id, success) if @callback
+            @callback&.completion(@job_id, success)
           end
 
           # Write data to the log buffer
@@ -122,7 +122,7 @@ module Cyclid
             @log_buffer.write data
 
             # Ping the callback log_write hook, if required
-            @callback.log_write(@job_id, data) if @callback
+            @callback&.log_write(@job_id, data)
           end
         end
       end

data/app/cyclid/plugins/provisioner/debian.rb

@@ -43,11 +43,12 @@ module Cyclid
             raise 'failed to update repositories' unless success
           end
 
-          env[:packages].each do |package|
+          if env.key? :packages
             success = transport.exec \
-              "sudo -E apt-get install -y #{package}"
-            raise "failed to install package #{package}" unless success
-          end if env.key? :packages
+              "sudo -E apt-get install -y #{env[:packages].join(' ')}" \
+
+            raise "failed to install packages #{env[:packages].join(' ')}" unless success
+          end
         rescue StandardError => ex
           Cyclid.logger.error "failed to provision #{buildhost[:name]}: #{ex}"
           raise
@@ -68,18 +69,18 @@ module Cyclid
             "echo '#{fragment}' | sudo tee -a /etc/apt/sources.list.d/cyclid.list"
           raise "failed to add repository #{url}" unless success
 
-          if repo.key? :key_id
-            # Import the signing key
-            key_id = repo[:key_id]
+          return unless repo.key? :key_id
 
-            success = transport.exec \
-              "gpg --keyserver keyserver.ubuntu.com --recv-keys #{key_id}"
-            raise "failed to import key #{key_id}" unless success
+          # Import the signing key
+          key_id = repo[:key_id]
 
-            success = transport.exec \
-              "gpg -a --export #{key_id} | sudo apt-key add -"
-            raise "failed to add repository key #{key_id}" unless success
-          end
+          success = transport.exec \
+            "gpg --keyserver keyserver.ubuntu.com --recv-keys #{key_id}"
+          raise "failed to import key #{key_id}" unless success
+
+          success = transport.exec \
+            "gpg -a --export #{key_id} | sudo apt-key add -"
+          raise "failed to add repository key #{key_id}" unless success
         end
 
         # Register this plugin

data/app/cyclid/plugins/provisioner/ubuntu.rb

@@ -46,11 +46,12 @@ module Cyclid
             raise 'failed to update repositories' unless success
           end
 
-          env[:packages].each do |package|
+          if env.key? :packages
             success = transport.exec \
-              "sudo -E apt-get install -y #{package}"
-            raise "failed to install package #{package}" unless success
-          end if env.key? :packages
+              "sudo -E apt-get install -y #{env[:packages].join(' ')}" \
+
+            raise "failed to install packages #{env[:packages].join(' ')}" unless success
+          end
         rescue StandardError => ex
           Cyclid.logger.error "failed to provision #{buildhost[:name]}: #{ex}"
           raise
@@ -76,18 +77,18 @@ module Cyclid
             "echo '#{fragment}' | sudo tee -a /etc/apt/sources.list.d/cyclid.list"
           raise "failed to add repository #{url}" unless success
 
-          if repo.key? :key_id
-            # Import the signing key
-            key_id = repo[:key_id]
+          return unless repo.key? :key_id
 
-            success = transport.exec \
-              "gpg --keyserver keyserver.ubuntu.com --recv-keys #{key_id}"
-            raise "failed to import key #{key_id}" unless success
+          # Import the signing key
+          key_id = repo[:key_id]
 
-            success = transport.exec \
-              "gpg -a --export #{key_id} | sudo apt-key add -"
-            raise "failed to add repository key #{key_id}" unless success
-          end
+          success = transport.exec \
+            "gpg --keyserver keyserver.ubuntu.com --recv-keys #{key_id}"
+          raise "failed to import key #{key_id}" unless success
+
+          success = transport.exec \
+            "gpg -a --export #{key_id} | sudo apt-key add -"
+          raise "failed to add repository key #{key_id}" unless success
         end
 
         # Register this plugin

data/app/cyclid/plugins/source/git.rb

@@ -48,7 +48,7 @@ module Cyclid
 
             branch = source[:branch]
 
-            match = url.path.match(%r{^.*\/(\w*)})
+            match = url.path.match(%r{^.*\/([^\.]*)})
             source_dir = "#{ctx[:workspace]}/#{match[1]}"
 
             success = transport.exec("git fetch origin #{branch}:#{branch}", source_dir)

data/app/cyclid/plugins/transport/ssh.rb

@@ -52,8 +52,10 @@ module Cyclid
                                         keys: keys,
                                         timeout: 5)
               break unless @session.nil?
-            rescue Net::SSH::AuthenticationFailed
+            rescue Net::SSH::Exception
               Cyclid.logger.debug 'SSH authentication failed'
+            rescue StandardError => ex
+              Cyclid.logger.debug "SSH connection failed: #{ex}"
             end
 
             sleep 5

data/app/cyclid/sinatra/api_helpers.rb

@@ -22,6 +22,12 @@ module Cyclid
   module API
     # Sinatra helpers
     module APIHelpers
+      # Return the raw request body
+      def request_body
+        request.body.rewind
+        request.body.read
+      end
+
       # Safely parse & validate the request body
       def parse_request_body
         # Parse the the request

data/lib/cyclid/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 module Cyclid
   module Api
-    VERSION = '0.2.1'
+    VERSION = '0.2.2'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cyclid
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Kristian Van Der Vliet
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-05 00:00:00.000000000 Z
+date: 2016-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
@@ -276,6 +276,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
 - !ruby/object:Gem::Dependency
   name: cyclid-core
   requirement: !ruby/object:Gem::Requirement
@@ -357,9 +371,14 @@ files:
 - app/cyclid/plugins/action/slack/note.erb
 - app/cyclid/plugins/api.rb
 - app/cyclid/plugins/api/github.rb
+- app/cyclid/plugins/api/github/README.md
 - app/cyclid/plugins/api/github/callback.rb
+- app/cyclid/plugins/api/github/config.rb
+- app/cyclid/plugins/api/github/helpers.rb
 - app/cyclid/plugins/api/github/methods.rb
-- app/cyclid/plugins/api/github/status.rb
+- app/cyclid/plugins/api/github/oauth.rb
+- app/cyclid/plugins/api/github/pull_request.rb
+- app/cyclid/plugins/api/github/push.rb
 - app/cyclid/plugins/builder.rb
 - app/cyclid/plugins/builder/mist.rb
 - app/cyclid/plugins/dispatcher.rb