twistlock-control 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a2dc8b1d3d971e07d8c0b16a4dfc4454e70ab808
+  data.tar.gz: a37cadbbaf5ef9f0f0541905cb6479dcb5992157
+SHA512:
+  metadata.gz: 2bc1a81f14f78aa5e612ebef2ff2acbebae0cb3bbaa397e70f654b43ee35ad9ce884d27dc0836b882aa0d13e0cb25481d44b9c6b38179833581dbf1941b77f74
+  data.tar.gz: 411fb2e9bdcd275d36754054ee3d1d6cbc7607929ca8003821dc86d5825d9a203ca8efa32a89949510b5189b7baac0b925395cdbd2ad2e7608d2a6b66389c45e

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+rethinkdb_data

data/.rubocop.yml

@@ -0,0 +1,6 @@
+Style/Tab:
+    Enabled: false
+Style/IndentationWidth:
+    Width: 1
+Metrics/LineLength:
+    Max: 120

data/Gemfile

@@ -0,0 +1,16 @@
+source 'https://rubygems.org'
+
+gem 'rspec'
+gem 'rspec-mocks'
+gem 'webmock'
+gem 'guard'
+gem 'guard-rspec'
+gem 'cucumber', require: false, group: :development
+gem 'guard-cucumber', group: :development
+gem 'rubocop', require: false
+gem 'guard-rubocop', group: :development
+gem 'simplecov', require: false, group: :test
+gem 'psych'
+
+# Specify your gem's dependencies in twistlock-control-models.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,30 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rsspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separetly)
+#  * 'just' rspec: 'rspec'
+guard :rspec, cmd: 'bundle exec rspec -c' do
+	watch(/^spec\/.+_spec\.rb$/) { 'spec' }
+	watch(/^lib\/.+\.rb$/) { 'spec' }
+	watch('spec/spec_helper.rb') { 'spec' }
+end
+
+guard :rubocop do
+	watch(/.+\.rb$/)
+	watch(/(?:.+\/)?\.rubocop\.yml$/) { |m| File.dirname(m[0]) }
+end
+
+guard 'cucumber' do
+	watch(/^features\/.+\.feature$/)
+	watch(%r{^features\/support\/.+$})          { 'features' }
+
+	watch(%r{^features/step_definitions/(.+)_steps\.rb$}) do |m|
+		Dir[File.join("**/#{m[1]}.feature")][0] || 'features'
+	end
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Tinco Andringa
+
+MIT License
+
+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,47 @@
+# TwistlockControl
+
+The Twistlock Control system.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'twistlock-control'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install twistlock-control
+
+## Usage
+
+The TwistlockControl system has a user interface called Rotterdam. Rotterdam executes
+the logic functions in here to manipulate the Twistlock provisioners. 
+
+Actions that Rotterdam needs that this library implements:
+
+  * Defining services
+  * Importing container descriptions
+  * Creating service instances
+  * Configuring service instances
+  * Adding provisioners
+  * Provisioning service instances on provisioners
+
+To aid these actions, Rotterdam needs to subscribe to the following resources:
+
+  * Defined services
+  * Imported container descriptions
+  * Service instances
+  * Provisioners
+  * Container instances
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/features/provisioning_service_instances.feature

@@ -0,0 +1,14 @@
+Feature: Provisioning service instances
+
+	In order for the user to make use of a service instance, it has to be
+	provisioned on a machine that's connected to Twistlock.
+
+	Scenario: A simple one-container service
+
+		Given a user has defined a service
+		Given a provisioner is configured
+		And a user has created an instance of that service
+		Then the user should be presented with a configurable representation of the service
+		When the user configures the service instance
+		And the user gives the provision command
+		Then a container instance should be provisioned

data/features/step_definitions/provisioning_service_instances_steps.rb

@@ -0,0 +1,33 @@
+Given(/^(?:a|the) user has defined a service$/) do
+	dir = Dir.pwd + '/../redis-container'
+	@service = Container.new(name: 'redis', url: dir)
+	@service.save
+end
+
+Given(/^a provisioner is configured$/) do
+	@provisioner = Provisioner.new(name: 'my-provisioner', url: 'localhost')
+	@provisioner.save
+end
+
+Given(/^(?:a|the) user has created an instance of that service$/) do
+	@service_instance = TwistlockControl::Actions::ServiceInstance.add('my-instance', @service)
+end
+
+Then(/^(?:a|the) user should be presented with a configurable representation of the service$/) do
+	@container_configuration = @service_instance.container_configurations.first
+end
+
+When(/^(?:a|the) user configures the service instance$/) do
+	@container_configuration.provisioner = @provisioner
+end
+
+When(/^(?:a|the) user gives the provision command$/) do
+	api_double = double
+	expect(api_double).to receive(:provision_container).and_return({})
+	expect(@provisioner).to receive(:api).and_return(api_double)
+	TwistlockControl::Actions::ContainerInstance.add(@container_configuration)
+end
+
+Then(/^a container instance should be provisioned$/) do
+	expect(ContainerInstance.all.length).to equal(1)
+end

data/features/support/env.rb

@@ -0,0 +1,22 @@
+require 'twistlock_control'
+
+require 'cucumber/rspec/doubles'
+
+include TwistlockControl
+
+def repositories
+	%w(provisioners services service_instances container_instances)
+		.map { |n| TwistlockControl::RethinkDBRepository[n] }
+end
+
+Before do
+	TwistlockControl.configure do |c|
+		c.database_name = 'test'
+	end
+
+	repositories.each(&:create_table)
+end
+
+After do
+	repositories.each(&:delete_all)
+end

data/lib/twistlock_control.rb

@@ -0,0 +1,65 @@
+require 'connection_pool'
+require 'rethinkdb'
+
+require_relative 'twistlock_control/provisioner_api'
+require_relative 'twistlock_control/rethinkdb_repository'
+
+require_relative 'twistlock_control/entities'
+require_relative 'twistlock_control/actions'
+require_relative 'twistlock_control/collections'
+
+#
+# TwistLockControl main module.
+#
+# Configure TwistlockControl by calling `TwistlockControl.configure`
+# and passing it a block in which you set the attributes.
+#
+module TwistlockControl
+	class << self
+		attr_accessor :connection_pool_size,
+		              :connection_pool_timeout,
+		              :rethinkdb_host,
+		              :rethinkdb_port,
+		              :database_name
+
+		def configure
+			yield self
+
+			set_defaults
+
+			setup_connection_pool
+		end
+
+		def database
+			RethinkDB::RQL.new.db(database_name)
+		end
+
+		def with_connection
+			@connection_pool.with do |conn|
+				yield conn
+			end
+		end
+
+		private
+
+		def set_defaults
+			@connection_pool_size ||= 5
+			@connection_pool_timeout ||= 5
+			@rethinkdb_host ||= 'localhost'
+			@rethinkdb_port ||= 28_015
+			@database_name ||= 'twistlock-control'
+		end
+
+		def setup_connection_pool
+			@connection_pool = ConnectionPool.new(
+				size:    connection_pool_size,
+				timeout: connection_pool_timeout
+			) do
+				RethinkDB::Connection.new(
+					host: rethinkdb_host,
+					port: rethinkdb_port
+				)
+			end
+		end
+	end
+end

data/lib/twistlock_control/actions.rb

@@ -0,0 +1,7 @@
+%w(
+	container
+	container_instance
+	provisioner
+	service
+	service_instance
+).each { |action| require_relative("actions/#{action}") }

data/lib/twistlock_control/actions/container.rb

@@ -0,0 +1,42 @@
+module TwistlockControl
+	# Actions that Rotterdam needs that this library implements:
+	module Actions
+		#  * Importing container descriptions
+		module Container
+			class << self
+				def add(properties)
+					container = Entities::Container.new(properties)
+					synchronize_description(container)
+					container
+				end
+
+				def update
+					fail 'not implemented'
+				end
+
+				def remove
+					fail 'not implemented'
+				end
+
+				def synchronize_description(container)
+					container.description = fetch_container_description(container)
+					container.save
+				end
+
+				private
+
+				def fetch_container_description(container)
+					nonce = SecureRandom.hex[0..7]
+					dirname = "/tmp/#{container.name}-#{nonce}"
+					FileUtils.mkdir_p dirname
+					Dir.chdir(dirname) do
+						`git clone -n --depth=1 #{container.url} .`
+						`git checkout HEAD twistlock.yml`
+						result = `cat twistlock.yml && rm -rf #{dirname}`
+						Entities::ContainerDescription.new(YAML.load(result))
+					end
+				end
+			end
+		end
+	end
+end

data/lib/twistlock_control/actions/container_instance.rb

@@ -0,0 +1,28 @@
+module TwistlockControl
+	# Actions that Rotterdam needs that this library implements:
+	module Actions
+		#  * Provisioning service instances on provisioners
+		module ContainerInstance
+			class << self
+				# Provision takes a ContainerConfiguration and when
+				# it is done provisioning it will notify the ContainerConfiguration
+				# of the ip address and container id of the provisioned container.
+				def add(container_configuration)
+					# TODO: figure out how to have internal actions like provisioning
+					# without polluting the entities with logic
+					provisioner = container_configuration.provisioner.api
+					properties = provisioner.provision_container(container_configuration)
+					instance = Entities::ContainerInstance.new(properties)
+					instance.save
+					instance
+				end
+
+				def update
+				end
+
+				def remove
+				end
+			end
+		end
+	end
+end

data/lib/twistlock_control/actions/provisioner.rb

@@ -0,0 +1,25 @@
+module TwistlockControl
+	# Actions that Rotterdam needs that this library implements:
+	module Actions
+		#  * Adding provisioners
+		module Provisioner
+			class << self
+				def add(properties)
+					provisioner = Entities::Provisioner.new(properties)
+					provisioner.save
+					provisioner
+				end
+
+				def update(id, properties)
+					provisioner = Entities::Provisioner.find_by_id(id)
+					provisioner.attributes = provisioner.attributes.merge properties
+					provisioner.save
+				end
+
+				def remove(id)
+					Entities::Provisioner.delete(id)
+				end
+			end
+		end
+	end
+end

data/lib/twistlock_control/actions/service.rb

@@ -0,0 +1,18 @@
+module TwistlockControl
+	# Actions that Rotterdam needs that this library implements:
+	module Actions
+		#  * Defining services
+		module Service
+			class << self
+				def add
+				end
+
+				def update
+				end
+
+				def remove
+				end
+			end
+		end
+	end
+end

data/lib/twistlock_control/actions/service_instance.rb

@@ -0,0 +1,40 @@
+module TwistlockControl
+	# Actions that Rotterdam needs that this library implements:
+	module Actions
+		#  * Creating service instances
+		#  * Configuring service instances
+		module ServiceInstance
+			class << self
+				def add(name, service)
+					configuration = build_configuration(service)
+					instance = Entities::ServiceInstance.new(service_id: service.id, name: name, configuration: configuration)
+					instance.save
+					instance
+				end
+
+				def update
+					fail 'not implemented'
+				end
+
+				def remove
+					fail 'not implemented'
+				end
+
+				private
+
+				def build_configuration(service)
+					case service.service_type
+					when :container then Entities::ContainerConfiguration.new(service_id: service.id)
+					when :composite
+						Entities::CompositeConfiguration.new(
+							service_id: service.id,
+							configurations: service.services.map { |s| build_configuration(s) }
+						)
+					else
+						fail "Unknown service type: #{service.service_type}"
+					end
+				end
+			end
+		end
+	end
+end