apcera-stager-api 0.2.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2bfd1296f1530b54b9151231b57d1d8abc47cac8
+  data.tar.gz: 949490f21990c5015e341479cd3e7b9b057e2eba
+SHA512:
+  metadata.gz: c1118b6f5b0ddf98df6358ee79f156b1fed19e0b1eaa0292e20c522f83cbfd700175fafc70ffec29457d2b662b179ddd9021096a0a4853a995798a61126138a9
+  data.tar.gz: f9cf88bf8cb869e537fee9e40408cf9b9bac59437480b418b180ea82f9a3ffbfde75f45d3d620d1f024be25494968c06d59703eca72dd3a13a8a3008834e9b4b

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.ruby-gemset
+.ruby-version
+.rvmrc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp/*
+.powenv
+.idea/

data/.travis.yml

@@ -0,0 +1,15 @@
+before_install:
+  - gem update --system 2.1.11
+language: ruby
+rvm:
+  - "1.8.7"
+  - "1.9.2"
+  - "1.9.3"
+  - "2.0.0"
+  - "2.1.0"
+  - "rbx"
+  - "jruby"
+matrix:
+  allow_failures:
+    - rvm: "rbx"
+    - rvm: "jruby"

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+Documentation started at the 0.2.5 release.
+
+## 0.2.5 apcera-stager-api
+
+### Added
+- Nothing.
+
+### Deprecated
+- Nothing.
+
+### Removed
+- Nothing.
+
+### Fixed
+- Has been renamed to apcera-stager-api

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014-2015 Apcera
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,86 @@
+# apcera-stager-api
+
+Simple gem to assist users writing stagers for the Apcera Platform.
+
+## Usage
+
+First create your Gemfile. The contents should be:
+
+```ruby
+source "https://rubygems.org"
+
+gem "apcera-stager-api"
+```
+
+Then run `bundle install` to download and install the gem and its dependencies.
+
+Now that your environment is setup, create a new file for your stager. We recommend "stager.rb".
+
+Start off with the contents:
+
+```ruby
+#!/usr/bin/env ruby
+
+require "bundler"
+Bundler.setup
+
+require "apcera-stager-api"
+
+stager = Apcera::Stager.new
+
+# Download the package from the staging coordinator.
+# This is the code that requires staging!
+puts "Downloading Package..."
+stager.download
+
+# Extract the package to the "app" directory.
+puts "Extracting Package..."
+stager.extract("app")
+
+# Your custom staging logic goes here.
+# This will be a set of commands to execute in order to stage
+# your applications.
+
+# Finish staging, this will upload your final package to the
+# staging coordinator.
+puts "Completed Staging..."
+stager.complete
+```
+
+## Deploying
+
+Deploying just requires you to run `apc stager create`.
+
+```console
+apc stager create mystager --start-command="./stager.rb" --staging=/apcera::ruby --pipeline
+```
+
+Now you can deploy apps using your stager with `apc app create`.
+
+```console
+apc app create someapp --staging=mystager --start
+```
+
+## License
+
+The MIT License (MIT)
+
+Copyright (c) 2014-2015 Apcera
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/Rakefile

@@ -0,0 +1,8 @@
+#!/usr/bin/env rake
+
+require File.join('bundler', 'gem_tasks')
+require File.join('rspec', 'core', 'rake_task')
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/apcera-stager-api-contrib.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+Gem::Specification.new do |gem|
+  gem.add_dependency "rest-client"
+  gem.add_dependency 'json'
+
+  gem.authors       = ["Josh Ellithorpe"]
+  gem.email         = ["josh@apcera.com"]
+  gem.description   = %q{Apcera Stager API Library}
+  gem.summary       = %q{Apcera Stager API library which makes it super easy to write stagers for the Apcera Platform.}
+  gem.homepage      = "http://apcera.com"
+  gem.license       = "MIT"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {spec}/*`.split("\n")
+  gem.name          = "apcera-stager-api"
+  gem.require_paths = ["lib"]
+  gem.version       = "0.2.5"
+
+  gem.add_development_dependency 'rspec', '~> 2.6.0'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'webmock', '1.11'
+  gem.add_development_dependency 'simplecov'
+  gem.add_development_dependency 'vcr'
+end

data/lib/apcera-stager-api.rb

@@ -0,0 +1 @@
+require File.join('apcera', 'stager', 'loader.rb')

data/lib/apcera/stager/error.rb

@@ -0,0 +1,8 @@
+module Apcera
+  module Error
+    class DownloadError < StandardError; end
+    class StagerURLRequired < StandardError; end
+    class ExecuteError < StandardError; end
+    class AppPathError < StandardError; end
+  end
+end

data/lib/apcera/stager/loader.rb

@@ -0,0 +1,11 @@
+require "bundler"
+Bundler.setup
+
+require 'rest-client'
+require 'json'
+
+base = File.expand_path File.dirname(__FILE__)
+
+Dir[File.join(base, '*.rb')].each do |file|
+  require file
+end

data/lib/apcera/stager/stager.rb

@@ -0,0 +1,335 @@
+module Apcera
+  class Stager
+    attr_accessor :stager_url, :app_path, :root_path, :pkg_path, :updated_pkg_path, :system_options
+
+    PKG_NAME = "pkg.tar.gz"
+    UPDATED_PKG_NAME = "updated.tar.gz"
+
+    def initialize(options = {})
+      # Require stager url. Needed to talk to the Staging Coordinator.
+      @stager_url = options[:stager_url] || ENV["STAGER_URL"]
+      raise Apcera::Error::StagerURLRequired.new("stager_url required") unless @stager_url
+
+      # Setup the environment, some test items here.
+      setup_environment
+    end
+
+    # Setup /stagerfs chroot environment so it is ready to run commands
+    # from pulled in dependencies. This does the following:
+    # - Setup working resolv.conf
+    # - Bind mounts /proc to /stagerfs/proc
+    # - Recursively bind mounts /dev to /stagerfs/dev
+    def setup_chroot
+      execute("sudo mkdir -p /stagerfs/etc")
+      execute("sudo cp /etc/resolv.conf /stagerfs/etc/resolv.conf")
+
+      execute("sudo mkdir -p /stagerfs/proc")
+      execute("sudo mount --bind /proc /stagerfs/proc")
+
+      execute("sudo mkdir -p /stagerfs/dev")
+      execute("sudo mount --rbind /dev /stagerfs/dev")
+    end
+
+    # Download a package from the staging coordinator.
+    # We use Net::HTTP here because it supports streaming downloads.
+    def download
+      uri = URI(@stager_url + "/data")
+
+      Net::HTTP.start(uri.host.to_s, uri.port.to_s) do |http|
+        request = Net::HTTP::Get.new uri.request_uri
+
+        http.request request do |response|
+          if response.code.to_i == 200
+            open @pkg_path, 'wb' do |io|
+              response.read_body do |chunk|
+                io.write chunk
+              end
+            end
+          else
+            raise Apcera::Error::DownloadError.new("package download failed.\n")
+          end
+        end
+      end
+    rescue => e
+      fail e
+    end
+
+    # Execute a command in the shell.
+    # We don't want real commands in tests.
+    def execute(cmd)
+      Bundler.with_clean_env do
+        result = system(cmd, @system_options)
+        if !result
+          raise Apcera::Error::ExecuteError.new("failed to execute: #{cmd}.\n")
+        end
+
+        result
+      end
+    rescue => e
+      fail e
+    end
+
+    # Execute a command in the app dir. Useful helper.
+    def execute_app(cmd)
+      raise_app_path_error if @app_path == nil
+      Bundler.with_clean_env do
+        Dir.chdir(@app_path) do |app_path|
+          result = system(cmd, @system_options)
+          if !result
+            raise Apcera::Error::ExecuteError.new("failed to execute: #{cmd}.\n")
+          end
+
+          result
+        end
+      end
+    rescue => e
+      fail e
+    end
+
+    # Extract the package to a given location.
+    def extract(location)
+      @app_path = File.join(@root_path, location)
+      Dir.mkdir(@app_path) unless Dir.exists?(@app_path)
+
+      execute_app("tar -zxf #{@pkg_path}")
+    rescue => e
+      fail e
+    end
+
+    # Upload the new package to the staging coordinator. If we have an app extracted we
+    # send that to the staging coordinator. If no app was ever extracted we just
+    # upload the unmodified app.
+    def upload
+      if @app_path == nil
+        unless File.exist?(@pkg_path)
+          download
+        end
+
+        upload_file(@pkg_path)
+      else
+        app_dir = Pathname.new(@app_path).relative_path_from(Pathname.new(@root_path)).to_s
+        execute_app("cd #{app_path}/.. && tar czf #{@updated_pkg_path} #{app_dir}")
+
+        upload_file(@updated_pkg_path)
+      end
+    rescue => e
+      fail e
+    end
+
+    # Snapshot the stager filesystem for app
+    def snapshot
+      response = RestClient.post(@stager_url+"/snapshot", {})
+    rescue => e
+      fail e
+    end
+
+    # Add environment variable to package.
+    def environment_add(key, value)
+      response = RestClient.put(stager_meta_url, {
+        :resource => "environment",
+        :action => "add",
+        :key => key,
+        :value => value
+      })
+    rescue => e
+      fail e
+    end
+
+    # Delete environment variable from package.
+    def environment_remove(key)
+      response = RestClient.put(stager_meta_url, {
+        :resource => "environment",
+        :action => "remove",
+        :key => key
+      })
+    rescue => e
+      fail e
+    end
+
+    # Add provides to package.
+    def provides_add(type, name)
+      response = RestClient.put(stager_meta_url, {
+        :resource => "provides",
+        :action => "add",
+        :type => type,
+        :name => name
+      })
+    rescue => e
+      fail e
+    end
+
+    # Delete provides from package.
+    def provides_remove(type, name)
+      response = RestClient.put(stager_meta_url, {
+        :resource => "provides",
+        :action => "remove",
+        :type => type,
+        :name => name
+      })
+    rescue => e
+      fail e
+    end
+
+    # Add dependencies to package.
+    def dependencies_add(type, name)
+      exists = self.meta["dependencies"].detect { |dep| dep["type"] == type && dep["name"] == name }
+      return false if exists
+
+      response = RestClient.put(stager_meta_url, {
+        :resource => "dependencies",
+        :action => "add",
+        :type => type,
+        :name => name
+      })
+
+      true
+    rescue => e
+      fail e
+    end
+
+    # Delete dependencies from package.
+    def dependencies_remove(type, name)
+      exists = self.meta["dependencies"].detect { |dep| dep["type"] == type && dep["name"] == name}
+      return false if !exists
+
+      response = RestClient.put(stager_meta_url, {
+        :resource => "dependencies",
+        :action => "remove",
+        :type => type,
+        :name => name
+      })
+
+      true
+    rescue => e
+      fail e
+    end
+
+    # Add template to package.
+    def templates_add(path, left_delimiter = "{{", right_delimiter = "}}")
+      response = RestClient.put(stager_meta_url, {
+        :resource => "templates",
+        :action => "add",
+        :path => path,
+        :left_delimiter => left_delimiter,
+        :right_delimiter => right_delimiter
+      })
+    rescue => e
+      fail e
+    end
+
+    # Delete template from package.
+    def templates_remove(path, left_delimiter = "{{", right_delimiter = "}}")
+      response = RestClient.put(stager_meta_url, {
+        :resource => "templates",
+        :action => "remove",
+        :path => path,
+        :left_delimiter => left_delimiter,
+        :right_delimiter => right_delimiter
+      })
+    rescue => e
+      fail e
+    end
+
+    # Get metadata for the package being staged.
+    def meta
+      response = RestClient.get(stager_meta_url)
+      return JSON.parse(response.to_s)
+    rescue => e
+      output_error "Error: #{e.message}.\n"
+      raise e
+    end
+
+    # Tell the staging coordinator you are done.
+    def done
+      response = RestClient.post(@stager_url+"/done", {})
+      exit0r 0
+    rescue => e
+      fail e
+    end
+
+    # Tell the staging coordinator you need to relaunch.
+    def relaunch
+      response = RestClient.post(@stager_url+"/relaunch", {})
+      exit0r 0
+    rescue => e
+      fail e
+    end
+
+    # Finish staging, compress your app dir and send to the staging coordinator.
+    # Then tell the staging coordinator we are done.
+    def complete
+      upload
+      done
+    end
+
+    # Returns the start command for the package.
+    def start_command
+      self.meta["environment"]["START_COMMAND"]
+    end
+
+    # Easily set the start command
+    def start_command=(val)
+      self.environment_add("START_COMMAND", val)
+    end
+
+    # Returns the start path for the package.
+    def start_path
+      self.meta["environment"]["START_PATH"]
+    end
+
+    # Easily set the start path
+    def start_path=(val)
+      self.environment_add("START_PATH", val)
+    end
+
+    # Fail the stager, something went wrong.
+    def fail(error = nil)
+      output_error "Error: #{error.message}.\n" if error
+      RestClient.post(@stager_url+"/failed", {})
+    rescue => e
+      output_error "Error: #{e.message}.\n"
+    ensure
+      exit0r 1
+    end
+
+    # Exit, needed for tests to not quit.
+    def exit0r(code)
+      exit code
+    end
+
+    # Output to stderr
+    def output_error(text)
+      $stderr.puts text
+    end
+
+    # Output to stdout
+    def output(text)
+      $stdout.puts text
+    end
+
+    private
+
+    def raise_app_path_error
+      raise Apcera::Error::AppPathError.new("app path not set, please run extract!\n")
+    end
+
+    def setup_environment
+      # When staging we use the root path. These are overridden in tests.
+      @root_path = "/tmp"
+      @pkg_path = File.join(@root_path, PKG_NAME)
+      @updated_pkg_path = File.join(@root_path, UPDATED_PKG_NAME)
+      @system_options = {}
+    end
+
+    def stager_meta_url
+      @stager_url + "/meta"
+    end
+
+    def upload_file(file)
+      sha256 = Digest::SHA256.file(file)
+      File.open(file, "rb") do |f|
+        response = RestClient.post(@stager_url+"/data?sha256=#{sha256.to_s}", f, { :content_type => "application/octet-stream" } )
+      end
+    end
+  end
+end