RubyGems - cyclid - Versions diffs - 0.2.0 - Mend

cyclid 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (71) hide show

checksums.yaml +7 -0
data/LICENSE +174 -0
data/README.md +54 -0
data/app/cyclid.rb +61 -0
data/app/cyclid/config.rb +38 -0
data/app/cyclid/controllers.rb +123 -0
data/app/cyclid/controllers/auth.rb +34 -0
data/app/cyclid/controllers/auth/token.rb +78 -0
data/app/cyclid/controllers/health.rb +96 -0
data/app/cyclid/controllers/organizations.rb +104 -0
data/app/cyclid/controllers/organizations/collection.rb +134 -0
data/app/cyclid/controllers/organizations/config.rb +128 -0
data/app/cyclid/controllers/organizations/document.rb +135 -0
data/app/cyclid/controllers/organizations/job.rb +266 -0
data/app/cyclid/controllers/organizations/members.rb +145 -0
data/app/cyclid/controllers/organizations/stages.rb +251 -0
data/app/cyclid/controllers/users.rb +47 -0
data/app/cyclid/controllers/users/collection.rb +131 -0
data/app/cyclid/controllers/users/document.rb +133 -0
data/app/cyclid/health_helpers.rb +40 -0
data/app/cyclid/job.rb +3 -0
data/app/cyclid/job/helpers.rb +67 -0
data/app/cyclid/job/job.rb +164 -0
data/app/cyclid/job/runner.rb +275 -0
data/app/cyclid/job/stage.rb +67 -0
data/app/cyclid/log_buffer.rb +104 -0
data/app/cyclid/models.rb +3 -0
data/app/cyclid/models/job_record.rb +25 -0
data/app/cyclid/models/organization.rb +64 -0
data/app/cyclid/models/plugin_config.rb +25 -0
data/app/cyclid/models/stage.rb +42 -0
data/app/cyclid/models/step.rb +29 -0
data/app/cyclid/models/user.rb +60 -0
data/app/cyclid/models/user_permissions.rb +28 -0
data/app/cyclid/monkey_patches.rb +37 -0
data/app/cyclid/plugin_registry.rb +75 -0
data/app/cyclid/plugins.rb +125 -0
data/app/cyclid/plugins/action.rb +48 -0
data/app/cyclid/plugins/action/command.rb +89 -0
data/app/cyclid/plugins/action/email.rb +207 -0
data/app/cyclid/plugins/action/email/html.erb +58 -0
data/app/cyclid/plugins/action/email/text.erb +13 -0
data/app/cyclid/plugins/action/script.rb +90 -0
data/app/cyclid/plugins/action/slack.rb +129 -0
data/app/cyclid/plugins/action/slack/note.erb +5 -0
data/app/cyclid/plugins/api.rb +195 -0
data/app/cyclid/plugins/api/github.rb +111 -0
data/app/cyclid/plugins/api/github/callback.rb +66 -0
data/app/cyclid/plugins/api/github/methods.rb +201 -0
data/app/cyclid/plugins/api/github/status.rb +67 -0
data/app/cyclid/plugins/builder.rb +80 -0
data/app/cyclid/plugins/builder/mist.rb +107 -0
data/app/cyclid/plugins/dispatcher.rb +89 -0
data/app/cyclid/plugins/dispatcher/local.rb +167 -0
data/app/cyclid/plugins/provisioner.rb +40 -0
data/app/cyclid/plugins/provisioner/debian.rb +90 -0
data/app/cyclid/plugins/provisioner/ubuntu.rb +98 -0
data/app/cyclid/plugins/source.rb +39 -0
data/app/cyclid/plugins/source/git.rb +64 -0
data/app/cyclid/plugins/transport.rb +63 -0
data/app/cyclid/plugins/transport/ssh.rb +155 -0
data/app/cyclid/sinatra/api_helpers.rb +66 -0
data/app/cyclid/sinatra/auth_helpers.rb +127 -0
data/app/cyclid/sinatra/warden/strategies/api_token.rb +62 -0
data/app/cyclid/sinatra/warden/strategies/basic.rb +58 -0
data/app/cyclid/sinatra/warden/strategies/hmac.rb +76 -0
data/app/db.rb +51 -0
data/bin/cyclid-db-init +107 -0
data/db/schema.rb +92 -0
data/lib/cyclid/app.rb +4 -0
metadata +407 -0

data/app/cyclid/plugins/action/email/html.erb ADDED

@@ -0,0 +1,58 @@
+<html>
+<head>
+<title><%= info[:title] %></title>
+<style>
+body {
+  font-family: Sans-Serif;
+}
+table {
+  width: 100%;
+  border: 1px solid black;
+  border-collapse: separate;
+  border-radius: 3px;
+}
+th {
+  border-radius: 3px;
+  height: 50px;
+  color: white;
+  font-size: x-large;
+  background: <%= info[:color] %>;
+}
+td {
+  padding: 4px;
+  /*font-size: smaller;*/
+}
+td.title {
+  font-weight: bold;
+  width: 10%;
+}
+td.data {
+  width: 90%;
+}
+td.header {
+  border-radius: 3px;
+  height: 35px;
+  background: lightgray;
+  font-size: large;
+  font-weight: bold;
+  color: black;
+}
+</style>
+</head>
+<body>
+<table>
+<th colspan="2"><%= info[:title] %></th>
+<tr><td class="title">Job ID:</td><td class="data"><%= ctx[:job_id] %></td></tr>
+<tr><td class="title">Job name:</td><td class="data"><%= ctx[:job_name] %></td></tr>
+<tr><td class="title">Organization:</td><td class="data"><%= ctx[:organization] %></td></tr>
+<tr><td class="title">Started:</td><td class="data"><%= ctx[:start] %></td></tr>
+<tr><td class="title">Ended:</td><td class="data"><%= ctx[:end] %></td></tr>
+<tr><td class="header" colspan="2">Message</td></tr>
+<tr><td class="data" colspan="2"><%= message %></td></tr>
+<tr><td class="header" colspan="2">Context</td></tr>
+<% ctx.each do |ctx_key, ctx_val| -%>
+<tr><td class="title"><%= ctx_key %><td class="data"><%= ctx_val %></td></tr>
+<% end -%>
+</table>
+</body>
+</html>

data/app/cyclid/plugins/action/email/text.erb ADDED

@@ -0,0 +1,13 @@
+Job ID: <%= ctx[:job_id] %>
+Job name: <%= ctx[:job_name] %>
+Organization: <%= ctx[:organization] %>
+Started: <%= ctx[:start] %>
+Ended: <%= ctx[:end] %>
+<%= message %>
+Context
+<% ctx.each do |ctx_key, ctx_val| -%>
+<%= ctx_key %>: <%= ctx_val %>
+<% end -%>

data/app/cyclid/plugins/action/script.rb ADDED

@@ -0,0 +1,90 @@
+# 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 'securerandom'
+# Top level module for the core Cyclid code.
+module Cyclid
+  # Module for the Cyclid API
+  module API
+    # Module for Cyclid Plugins
+    module Plugins
+      # Script plugin
+      class Script < Action
+        def initialize(args = {})
+          args.symbolize_keys!
+          # At a bare minimum there has to be a script to execute.
+          raise 'a command action requires a script' unless args.include? :script
+          # Scripts can either be a single string, or an array of strings
+          # which we will join back together
+          @script = if args[:script].is_a? String
+                      args[:script]
+                    elsif args[:script].is_a? Array
+                      args[:script].join("\n")
+                    end
+          # If no explicit path was given, create a temporary filename.
+          # XXX This assumes the remote system has a /tmp, that it's writable
+          # and not mounted NOEXEC, but there's no easy way to do this?
+          @path = if args.include? :path
+                    args[:path]
+                  else
+                    file = "cyclid_#{SecureRandom.hex(16)}"
+                    File.join('/', 'tmp', file)
+                  end
+          @env = args[:env] if args.include? :env
+          Cyclid.logger.debug "script: '#{@script}' path: #{@path}"
+        end
+        # Run the script action
+        def perform(log)
+          begin
+            # Export the environment data to the build host, if necesary
+            env = @env.interpolate(@ctx) if @env
+            @transport.export_env(env)
+            # Add context data
+            script = @script % @ctx
+            path = @path % @ctx
+            # Create an IO object containing the script and upload it to the
+            # build host
+            log.write("Uploading script to #{path}\n")
+            io = StringIO.new(script)
+            @transport.upload(io, path)
+            # Execute the script
+            log.write("Running script from #{path}...\n")
+            success = @transport.exec("chmod +x #{path} && #{path}")
+          rescue KeyError => ex
+            # Interpolation failed
+            log.write "#{ex.message}\n"
+            success = false
+          end
+          [success, @transport.exit_code]
+        end
+        # Register this plugin
+        register_plugin 'script'
+      end
+    end
+  end
+end

data/app/cyclid/plugins/action/slack.rb ADDED

@@ -0,0 +1,129 @@
+# 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 'slack-notifier'
+# Top level module for the core Cyclid code.
+module Cyclid
+  # Module for the Cyclid API
+  module API
+    # Module for Cyclid Plugins
+    module Plugins
+      # Slack notification plugin
+      class Slack < Action
+        def initialize(args = {})
+          args.symbolize_keys!
+          raise 'a slack action requires a subject' unless args.include? :subject
+          @subject = args[:subject]
+          @url = args[:url] if args.include? :url
+          @color = args[:color] || 'good'
+          @message = args[:message] if args.include? :message
+        end
+        # Send a Slack notification to the configured endpoint; the message is
+        # rendered via. an ERB template which inserts additional information
+        # from the context and is attached as a Slack message note
+        def perform(log)
+          begin
+            plugin_data = self.class.get_config(@ctx[:organization])
+            Cyclid.logger.debug "using plugin config #{plugin_data}"
+            config = plugin_data['config']
+            subject = @subject % @ctx
+            url = @url || config['webhook_url']
+            raise 'no webhook URL given' if url.nil?
+            url = url % @ctx
+            Cyclid.logger.debug "sending notification to #{url}"
+            message_text = @message % @ctx if @message
+            # Create a binding for the template
+            bind = binding
+            bind.local_variable_set(:ctx, @ctx)
+            # Generate the context information from a templete
+            template_path = File.expand_path(File.join(__FILE__, '..', 'slack', 'note.erb'))
+            template = ERB.new(File.read(template_path), nil, '%<>-')
+            context_text = template.result(bind)
+            # Create a "note" and send it as part of the message
+            fields = if @message
+                       [{ title: 'Message', value: message_text }]
+                     else
+                       []
+                     end
+            fields << { title: 'Information',
+                        value: context_text,
+                        short: false }
+            note = { fallback: message_text || subject,
+                     color: @color,
+                     fields: fields }
+            # Send the notification to the Slack webhook
+            notifier = ::Slack::Notifier.new url
+            notifier.username = 'Cyclid'
+            res = notifier.ping subject, attachments: [note]
+            rc = res.code
+            success = rc == '200'
+          rescue StandardError => ex
+            log.write "#{ex.message}\n"
+            success = false
+            rc = 0
+          end
+          [success, rc]
+        end
+        # Register this plugin
+        register_plugin 'slack'
+        # Static methods for handling plugin config data
+        class << self
+          # Update the plugin configuration
+          def update_config(current, new)
+            current.merge! new
+          end
+          # Default configuration for the Slack plugin
+          def default_config
+            config = {}
+            config['webhook_url'] = nil
+            return config
+          end
+          # Config schema for the Slack plugin
+          def config_schema
+            schema = []
+            schema << { name: 'webhook_url',
+                        type: 'string',
+                        description: 'Slack incoming webhook URL for your team',
+                        default: nil }
+            return schema
+          end
+        end
+      end
+    end
+  end
+end

data/app/cyclid/plugins/action/slack/note.erb ADDED

@@ -0,0 +1,5 @@
+Job ID: <%= ctx[:job_id] %>
+Job name: <%= ctx[:job_name] %>
+Organization: <%= ctx[:organization] %>
+Started: <%= ctx[:start] %>
+Ended: <%= ctx[:end] %>

data/app/cyclid/plugins/api.rb ADDED

@@ -0,0 +1,195 @@
+# 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.
+# 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
+        # Sinatra controller; this is more complex than usual to allow the
+        # plugin to connect it's own set of methods as callbacks.
+        class Controller < Module
+          attr_reader :plugin_methods
+          def initialize(methods = nil)
+            @plugin_methods = methods
+          end
+          # Sinatra callback
+          def registered(app)
+            include Errors::HTTPErrors
+            app.get do
+              Cyclid.logger.debug 'ApiExtension::Controller::get'
+              org = Organization.find_by(name: params[:name])
+              halt_with_json_response(404, INVALID_ORG, 'organization does not exist') \
+                if org.nil?
+              config = controller_plugin.get_config(org)
+              get(http_headers(request.env), config['config'])
+            end
+            app.post do
+              Cyclid.logger.debug 'ApiExtension::Controller::post'
+              payload = parse_request_body
+              org = Organization.find_by(name: params[:name])
+              halt_with_json_response(404, INVALID_ORG, 'organization does not exist') \
+                if org.nil?
+              config = controller_plugin.get_config(org)
+              post(payload, http_headers(request.env), config['config'])
+            end
+            app.put do
+              Cyclid.logger.debug 'ApiExtension::Controller::put'
+              payload = parse_request_body
+              org = Organization.find_by(name: params[:name])
+              halt_with_json_response(404, INVALID_ORG, 'organization does not exist') \
+                if org.nil?
+              config = controller_plugin.get_config(org)
+              put(payload, http_headers(request.env), config['config'])
+            end
+            app.delete do
+              Cyclid.logger.debug 'ApiExtension::Controller::delete'
+              org = Organization.find_by(name: params[:name])
+              halt_with_json_response(404, INVALID_ORG, 'organization does not exist') \
+                if org.nil?
+              config = controller_plugin.get_config(org)
+              delete(http_headers(request.env), config['config'])
+            end
+            app.helpers do
+              include Helpers
+              include Job::Helpers
+            end
+          end
+        end
+        # Default method callbacks.
+        #
+        # The use of a 405 response here is slightly wrong as technically each
+        # method *is* implemented. We're supposed to send back an Allow: header
+        # to indicate which methods we do support, but that'd be all four of
+        # them...
+        module Methods
+          # GET callback
+          def get(_headers, _config)
+            authorize('get')
+            return_failure(405, 'not implemented')
+          end
+          # POST callback
+          def post(_data, _headers, _config)
+            authorize('post')
+            return_failure(405, 'not implemented')
+          end
+          # PUT callback
+          def put(_data, _headers, _config)
+            authorize('put')
+            return_failure(405, 'not implemented')
+          end
+          # DELETE callback
+          def delete(_headers, _config)
+            authorize('delete')
+            return_failure(405, 'not implemented')
+          end
+        end
+        # Standard helpers for API extensions. Mostly the point is to try to
+        # hide as much of the underlying Sinatra implementation as possible and
+        # simplify (& therefore control) the plugins ability to interact with
+        # Sinatra.
+        module Helpers
+          # Wrapper around the standard Warden authn/authz
+          #
+          # ApiExtension methods can choose to be authenticated or
+          # unauthenticated; for example a callback hook from an external SCM
+          # could accept unauthenticated POST's that trigger some action.
+          #
+          # The callback method implementations can choose to call authorize()
+          # if the endpoint would be authenticated, or not to call it in which
+          # case the method would be unauthenticated.
+          def authorize(method)
+            operation = if method.casecmp 'get'
+                          Operations::READ
+                        elsif method.casecmp 'put'
+                          Operations::WRITE
+                        elsif method.casecmp 'post' or
+                              method.casecmp 'delete'
+                          Operations::ADMIN
+                        else
+                          raise "invalid method '#{method}'"
+                        end
+            authorized_for!(params[:name], operation)
+          end
+          # Return a standard Cyclid style failure.
+          def return_failure(code, message)
+            halt_with_json_response(code, Errors::HTTPErrors::PLUGIN_ERROR, message)
+          end
+          # Extract headers from the raw request & pretty them up
+          def http_headers(environment)
+            http_headers = headers
+            environment.each do |env|
+              key, value = env
+              match = key.match(/\AHTTP_(.*)\Z/)
+              next unless match
+              header = match[1].split('_').map(&:capitalize).join('-')
+              http_headers[header] = value
+            end
+            return http_headers
+          end
+        end
+      end
+      # Base class for Api plugins
+      class Api < Base
+        # Return a new instance of the Sinatra controller
+        def self.controller
+          return ApiExtension::Controller.new(ApiExtension::Methods)
+        end
+        # Return the 'human' name for the plugin type
+        def self.human_name
+          'api'
+        end
+      end
+    end
+  end
+end
+require_rel 'api/*.rb'