cyclid-lxd-plugin 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 28191bf50cd5de65833791d6de820ca8e16b5e9e
+  data.tar.gz: fee02e95b7031694e032d00b13aa58136f338951
+SHA512:
+  metadata.gz: 792ea700154e73b4ded74ec0e31fe9d4270044fcc8f0c987dfba61694d4647866b7b700b1f20a827a871fa547a10858b44588bb850bdf5b9bc71774c43431467
+  data.tar.gz: 10995f857e821416149dfe18907e46539f5d98f0d13a8426b7673a7371711085c940af54177dc467a2a61baa291d4af1ff25d5c5edb14be8f0f8733e13bbf377

data/lib/cyclid/plugins/builder/lxd.rb

@@ -0,0 +1,172 @@
+# 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 'hyperkit'
+
+# Top level module for the core Cyclid code.
+module Cyclid
+  # Module for the Cyclid API
+  module API
+    # Module for Cyclid Plugins
+    module Plugins
+      # LXD build host
+      class LxdHost < BuildHost
+        # LXD is the only acceptable Transport
+        def transports
+          ['lxdapi']
+        end
+      end
+
+      # LXD builder. Uses the LXD REST API to create a build host container.
+      class Lxd < Builder
+        def initialize
+          @config = load_lxd_config(Cyclid.config.plugins)
+          @client = Hyperkit::Client.new(api_endpoint: @config[:api],
+                                         verify_ssl: @config[:verify_ssl],
+                                         client_cert: @config[:client_cert],
+                                         client_key: @config[:client_key])
+        end
+
+        # Create & return a build host
+        def get(args = {})
+          args.symbolize_keys!
+
+          Cyclid.logger.debug "lxd: args=#{args}"
+
+          # If there is one, split the 'os' into a 'distro' and 'release'
+          if args.key? :os
+            match = args[:os].match(/\A(\w*)_(.*)\Z/)
+            distro = match[1] if match
+            release = match[2] if match
+          else
+            # No OS was specified; use the default
+            # XXX Defaults should be configurable
+            distro = 'ubuntu'
+            release = 'trusty'
+          end
+
+          # Find the template fingerprint for the given distribution & release
+          image_alias = "#{distro}/#{release}"
+          fingerprint = find_or_create_image(image_alias)
+          Cyclid.logger.debug "fingerprint=#{fingerprint}"
+
+          # Create a new instance
+          name = create_name
+          create_container(name, fingerprint)
+
+          # Wait for the instance to settle
+          sleep 5
+
+          # Create a buildhost from the container details
+          buildhost = LxdHost.new(host: name,
+                                  name: name,
+                                  username: 'root',
+                                  workspace: '/root',
+                                  distro: distro,
+                                  release: release)
+
+          buildhost
+        end
+
+        # Destroy the build host
+        def release(_transport, buildhost)
+          name = buildhost[:host]
+
+          @client.stop_container(name)
+          wait_for_container(name, 'Stopped')
+
+          @client.delete_container(name)
+        rescue StandardError => ex
+          Cyclid.logger.error "LXD destroy timed out: #{ex}"
+        end
+
+        # Register this plugin
+        register_plugin 'lxd'
+
+        private
+
+        # Load the config for the LXD Builder plugin and set defaults if they're not
+        # in the config
+        def load_lxd_config(config)
+          config.symbolize_keys!
+
+          lxd_config = config[:lxd] || {}
+          lxd_config.symbolize_keys!
+          Cyclid.logger.debug "config=#{lxd_config}"
+
+          raise 'the LXD API URL must be provided' \
+            unless lxd_config.key? :api
+
+          lxd_config[:client_cert] = File.join(%w(/ etc cyclid lxd_client.crt)) \
+            unless lxd_config.key? :client_cert
+          lxd_config[:client_key] = File.join(%w(/ etc cyclid lxd_client.key)) \
+            unless lxd_config.key? :client_key
+
+          lxd_config[:verify_ssl] = false \
+            unless lxd_config.key? :verify_ssl
+          lxd_config[:image_server] = 'https://images.linuxcontainers.org:8443' \
+            unless lxd_config.key? :image_server
+          lxd_config[:instance_name] = 'cyclid-build' \
+            unless lxd_config.key? :instance_name
+
+          lxd_config
+        end
+
+        def find_or_create_image(image_alias)
+          Cyclid.logger.debug "Create image #{image_alias}"
+          fingerprint = ''
+          begin
+            image = @client.image_by_alias(image_alias)
+            Cyclid.logger.debug "found image=#{image.inspect}"
+            fingerprint = image.fingerprint
+          rescue Hyperkit::NotFound
+            Cyclid.logger.debug "Downloading image for #{image_alias}"
+            image = @client.create_image_from_remote(@config[:image_server],
+                                                     alias: image_alias,
+                                                     protocol: 'simplestreams')
+
+            Cyclid.logger.debug "created image=#{image.inspect}"
+            fingerprint = image.metadata.fingerprint
+            @client.create_image_alias(fingerprint, image_alias)
+          end
+
+          fingerprint
+        end
+
+        def create_container(name, fingerprint)
+          Cyclid.logger.debug "Creating container #{name}"
+          @client.create_container(name, fingerprint: fingerprint)
+          @client.start_container(name)
+
+          wait_for_container(name, 'Running')
+        end
+
+        def wait_for_container(name, state)
+          29.times.each do |_t|
+            status = @client.container(name).status
+            break if status == state
+            Cyclid.logger.debug status
+            sleep 2
+          end
+        end
+
+        def create_name
+          base = @config[:instance_name]
+          "#{base}-#{SecureRandom.hex(16)}"
+        end
+      end
+    end
+  end
+end

data/lib/cyclid/plugins/transport/lxdapi.rb

@@ -0,0 +1,163 @@
+# 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 'hyperkit'
+require 'websocket-client-simple'
+
+# Top level module for the core Cyclid code.
+module Cyclid
+  # Module for the Cyclid API
+  module API
+    # Module for Cyclid Plugins
+    module Plugins
+      # LXD based transport
+      class LxdApi < Transport
+        attr_reader :exit_code, :exit_signal
+
+        def initialize(args = {})
+          args.symbolize_keys!
+
+          Cyclid.logger.debug "args=#{args}"
+
+          # Container name & a log target are required
+          return false unless args.include?(:host) && \
+                              args.include?(:log)
+
+          @name = args[:host]
+          @log = args[:log]
+          Cyclid.logger.debug "log=#{@log}"
+
+          @config = load_lxd_config(Cyclid.config.plugins)
+          @client = Hyperkit::Client.new(api_endpoint: @config[:api],
+                                         verify_ssl: @config[:verify_ssl],
+                                         client_cert: @config[:client_cert],
+                                         client_key: @config[:client_key])
+
+          # Grab some data from the context
+          ctx = args[:ctx]
+          @base_env = { 'HOME' => ctx[:workspace],
+                        'TERM' => 'xterm-mono' }
+        end
+
+        # Execute a command via. the LXD API
+        def exec(cmd, path = nil)
+          command = build_command(cmd, path)
+          Cyclid.logger.debug "command=#{command}"
+
+          # Ensure some important variables are set, like HOME & TERM
+          env = @env || {}
+          env = env.merge @base_env
+
+          # Run the command...
+          rc = @client.execute_command(@name,
+                                       command,
+                                       environment: env,
+                                       wait_for_websocket: true,
+                                       interactive: true,
+                                       sync: false)
+
+          # ... and then connect a Websocket and read the output
+          operation = rc[:id]
+          ws_secret = rc[:metadata][:fds][:'0']
+          ws_url = "#{@config[:api]}/1.0/operations/#{operation}/websocket?secret=#{ws_secret}"
+
+          closed = false
+          log = @log
+          WebSocket::Client::Simple.connect ws_url do |ws|
+            ws.on :message do |msg|
+              close if msg.data.empty?
+              # Strip out any XTerm control characters and convert lint endings
+              data = msg.data.force_encoding('UTF-8')
+                        .gsub(/\r\n/, "\n")
+                        .gsub(/\r+/, "\n")
+                        .gsub(/\033\[(.?\d+\D?|\w+)/, '')
+
+              log.write data
+            end
+            ws.on :open do
+              Cyclid.logger.debug 'websocket opened'
+              closed = false
+            end
+            ws.on :close do |e|
+              Cyclid.logger.debug "websocket closed: #{e}"
+              closed = true
+            end
+            ws.on :error do |e|
+              Cyclid.logger.debug "websocket error: #{e}"
+            end
+          end
+
+          # Wait until the Websocket thread has finished.
+          loop do
+            break if closed
+            sleep 1
+          end
+
+          # Get exit status
+          status = @client.operation(operation)
+          Cyclid.logger.debug "status=#{status.inspect}"
+
+          @exit_code = status[:metadata][:return]
+          @exit_code.zero? ? true : false
+        end
+
+        # Copy data from a local IO object to a remote file via. the API
+        def upload(io, path)
+          @client.push_file(io, @name, path)
+        end
+
+        # Copy a data from remote file to a local IO object
+        def download(io, path)
+          @client.pull_file(@name, path, io)
+        end
+
+        # Register this plugin
+        register_plugin 'lxdapi'
+
+        private
+
+        # Load the config for the LXD Builder plugin and set defaults if they're not
+        # in the config
+        def load_lxd_config(config)
+          config.symbolize_keys!
+
+          lxd_config = config[:lxd] || {}
+          lxd_config.symbolize_keys!
+          Cyclid.logger.debug "config=#{lxd_config}"
+
+          raise 'the LXD API URL must be provided' \
+            unless lxd_config.key? :api
+
+          lxd_config[:client_cert] = File.join(%w(/ etc cyclid lxd_client.crt)) \
+            unless lxd_config.key? :client_cert
+          lxd_config[:client_key] = File.join(%w(/ etc cyclid lxd_client.key)) \
+            unless lxd_config.key? :client_key
+
+          lxd_config[:verify_ssl] = false \
+            unless lxd_config.key? :verify_ssl
+
+          lxd_config
+        end
+
+        def build_command(cmd, path = nil)
+          command = []
+          command << "cd #{path}" if path
+          command << cmd
+          "sh -l -c '#{command.join(';')}'"
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: cyclid-lxd-plugin
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kristian Van Der Vliet
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hyperkit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: websocket-client-simple
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: cyclid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+description: Creates LXD container basedt build hosts
+email: contact@cyclid.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/cyclid/plugins/builder/lxd.rb
+- lib/cyclid/plugins/transport/lxdapi.rb
+homepage: https://cyclid.io
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Cyclid LXD Builder & Transport plugin
+test_files: []