foreman_deployments 0.0.1

data/test/unit/lib/validation/validation_visitor_test.rb

@@ -0,0 +1,67 @@
+require 'test_helper'
+
+class ValidationVisitorTest < ActiveSupport::TestCase
+  class TestTask < ForemanDeployments::Tasks::BaseDefinition
+    def validate
+      ForemanDeployments::Validation::ValidationResult.new
+    end
+
+    def preliminary_output
+      {}
+    end
+  end
+
+  class TestResource
+  end
+
+  def mock_deployment(task_hash)
+    task_hash.stubs(:deep_clone).returns(task_hash)
+    task_hash
+  end
+
+  let(:valid_result) { ForemanDeployments::Validation::ValidationResult.new }
+
+  setup do
+    @visitor = ForemanDeployments::Validation::ValidationVisitor.new
+  end
+
+  test 'it is valid when there are no tasks' do
+    definition = ForemanDeployments::StackDefinition.new
+    definition.accept(@visitor)
+
+    assert(@visitor.result.valid?)
+  end
+
+  test 'it validates all tasks' do
+    valid_task1 = TestTask.new
+    valid_task1.expects(:validate).once.returns(valid_result)
+
+    valid_task2 = TestTask.new
+    valid_task2.expects(:validate).once.returns(valid_result)
+
+    definition = ForemanDeployments::StackDefinition.new(
+      :task1 => valid_task1,
+      :task2 => valid_task2
+    )
+    definition.accept(@visitor)
+  end
+
+  test 'it returns messages from all the tasks' do
+    valid_task1 = TestTask.new
+    valid_task1.expects(:validate).once.returns(valid_result)
+
+    invalid_task2 = TestTask.new
+    invalid_task2.expects(:validate).once.returns(
+      ForemanDeployments::Validation::ValidationResult.new(:name => 'Name must be unique')
+    )
+
+    definition = ForemanDeployments::StackDefinition.new(
+      :task1 => valid_task1,
+      :task2 => invalid_task2
+    )
+    definition.accept(@visitor)
+
+    refute(@visitor.result.valid?)
+    assert_equal({ 'task2' => { :name => 'Name must be unique' } }, @visitor.result.messages)
+  end
+end

data/test/unit/model/configuration_test.rb

@@ -0,0 +1,88 @@
+require 'test_helper'
+
+class ConfigurationTest < ActiveSupport::TestCase
+  setup do
+    @stack = ForemanDeployments::Stack.new(
+      :name => 'stack1',
+      :definition => 'def'
+    )
+    @deployment = ForemanDeployments::Deployment.new(
+      :name => 'deployment1'
+    )
+    @valid_params = {
+      :description => 'stack1 pre-configuration',
+      :stack => @stack,
+      :deployment => @deployment
+    }
+  end
+
+  describe 'validations' do
+    test 'valid attributes' do
+      c = ForemanDeployments::Configuration.new(@valid_params)
+      assert(c.valid?)
+    end
+
+    test 'description is not required' do
+      c = ForemanDeployments::Configuration.new(@valid_params.except(:description))
+      assert(c.valid?)
+    end
+
+    test 'stack is required' do
+      c = ForemanDeployments::Configuration.new(@valid_params.except(:stack))
+      refute(c.valid?)
+    end
+
+    test 'deployment is optional' do
+      c = ForemanDeployments::Configuration.new(@valid_params.except(:deployment))
+      assert(c.valid?)
+    end
+  end
+
+  describe 'default_description' do
+    test 'it mentions the stack when deployment is empty' do
+      c = ForemanDeployments::Configuration.new(@valid_params.except(:description, :deployment))
+      assert_equal('Saved configuration for stack1', c.default_description)
+    end
+
+    test 'it mentions the deployment when it is present' do
+      c = ForemanDeployments::Configuration.new(@valid_params.except(:description))
+      assert_equal('Configuration for deployment1', c.default_description)
+    end
+
+    test 'it returns nil when neither stack nor deployment is set' do
+      c = ForemanDeployments::Configuration.new(@valid_params.except(:description, :deployment, :stack))
+      assert_nil(c.default_description)
+    end
+  end
+
+  describe 'configure' do
+    setup do
+      @stack.save!
+      @conf = ForemanDeployments::Configuration.new(:stack => @stack, :description => 'config')
+      @values = {
+        :param_a => 1,
+        :param_b => {
+          :param_c => 2
+        }
+      }
+      @unknown_task = stub(:task_id => 'UnknownTask')
+      @some_task = stub(:task_id => 'SomeTask')
+    end
+
+    test 'it gives empty hash for unconfigured tasks' do
+      assert_equal({}, @conf.get_config_for(@unknown_task))
+    end
+
+    test 'it returns configured values' do
+      @conf.set_config_for(@some_task, @values)
+      assert_equal(@values, @conf.get_config_for(@some_task))
+    end
+
+    test 'it saves the values' do
+      @conf.set_config_for(@some_task, @values)
+      @conf.save
+
+      assert_equal(@values, ForemanDeployments::Configuration.find(@conf.id).get_config_for(@some_task))
+    end
+  end
+end

data/test/unit/model/deployment_test.rb

@@ -0,0 +1,159 @@
+require 'test_plugin_helper'
+
+class DeploymentTest < ActiveSupport::TestCase
+  include RegistryStub
+
+  class FakeTask < ForemanDeployments::Tasks::BaseDefinition; end
+
+  setup do
+    @stack = FactoryGirl.build(:stack,
+                               :organizations => [taxonomies(:organization1)],
+                               :locations => [taxonomies(:location1)]
+    )
+    @config = ForemanDeployments::Configuration.new(
+      :description => 'config for deployment1',
+      :stack => @stack
+    )
+    @valid_params = {
+      :name => 'deployment1',
+      :configuration => @config,
+      :organization => taxonomies(:organization1),
+      :location => taxonomies(:location1)
+    }
+
+    @registry = stub_registry
+    @registry.register_task(FakeTask)
+
+    @task = FactoryGirl.build(:foreman_task)
+    ForemanTasks.stubs(:async_task).returns(@task)
+  end
+
+  describe 'validations' do
+    test 'valid attributes' do
+      d = ForemanDeployments::Deployment.new(@valid_params)
+      assert(d.valid?)
+    end
+
+    test 'name must be present' do
+      d = ForemanDeployments::Deployment.new(@valid_params.except(:name))
+      refute(d.valid?)
+    end
+
+    test 'configuration must be present' do
+      d = ForemanDeployments::Deployment.new(@valid_params.except(:configuration))
+      refute(d.valid?)
+    end
+
+    test 'organization must be present' do
+      d = ForemanDeployments::Deployment.new(@valid_params.except(:organization))
+      refute(d.valid?)
+    end
+
+    test "organization must be one of stack's orgs" do
+      d = ForemanDeployments::Deployment.new(@valid_params.merge(:organization => taxonomies(:organization2)))
+      refute(d.valid?)
+    end
+
+    test 'location must be present' do
+      d = ForemanDeployments::Deployment.new(@valid_params.except(:location))
+      refute(d.valid?)
+    end
+
+    test "organization must be one of stack's orgs" do
+      d = ForemanDeployments::Deployment.new(@valid_params.merge(:location => taxonomies(:location2)))
+      refute(d.valid?)
+    end
+  end
+
+  describe 'status' do
+    setup do
+      @deployment = ForemanDeployments::Deployment.new(:task => @task)
+    end
+
+    test 'is :configuration when no task exist' do
+      @deployment.task = nil
+      assert_equal(:configuration, @deployment.status)
+    end
+
+    test 'is :running when the task is running' do
+      assert_equal(:running, @deployment.status)
+    end
+
+    test 'is :paused when the task is paused' do
+      @task.state = 'paused'
+      @task.result = 'success'
+      assert_equal(:paused, @deployment.status)
+    end
+
+    test 'is :deployed when the task successfully finished' do
+      @task.state = 'stopped'
+      @task.result = 'success'
+      assert_equal(:deployed, @deployment.status)
+    end
+
+    test 'is :failed when the task failed' do
+      @task.state = 'stopped'
+      @task.result = 'error'
+      assert_equal(:failed, @deployment.status)
+    end
+  end
+
+  describe 'run' do
+    test 'it refuses to run a deployment that is already running' do
+      deployment = ForemanDeployments::Deployment.new(@valid_params)
+      deployment.stubs(:status).returns(:running)
+      e = assert_raises Foreman::Exception do
+        deployment.run
+      end
+      assert_match("You can't start a deployment that is already running!", e.message)
+    end
+
+    test 'it refuses to run a stack has some validation errors' do
+      deployment = ForemanDeployments::Deployment.new(@valid_params)
+      deployment.parsed_stack.stubs(:validate!).raises(
+        ForemanDeployments::Validation::ValidationError.new({}, 'validation failure')
+      )
+
+      assert_raises ForemanDeployments::Validation::ValidationError do
+        deployment.run
+      end
+    end
+
+    test 'it plans a foreman task' do
+      deployment = ForemanDeployments::Deployment.new(@valid_params)
+      deployment.configuration.set_config_for(stub(:task_id => 'Task1'), 'param1' => '1')
+      deployment.configuration.save
+      deployment.parsed_stack.stubs(:validate!)
+
+      ForemanTasks.expects(:async_task).with do |main_task, parsed_stack|
+        assert_equal(ForemanDeployments::Tasks::StackDeployAction, main_task)
+        assert_equal({ 'param1' => '1' }, parsed_stack.tasks['Task1'].configuration)
+      end
+
+      deployment.run
+    end
+
+    test 'it saves the task id' do
+      deployment = ForemanDeployments::Deployment.new(@valid_params)
+      deployment.parsed_stack.stubs(:validate!)
+
+      deployment.run
+      assert_equal(@task.id, deployment.task_id)
+    end
+  end
+
+  describe 'stack' do
+    test 'returns nil by default' do
+      deployment = ForemanDeployments::Deployment.new
+      assert_nil(deployment.stack)
+    end
+
+    test 'returns stack of the configuration' do
+      stack = ForemanDeployments::Stack.new
+      config = ForemanDeployments::Configuration.new(:stack => stack)
+      deployment = ForemanDeployments::Deployment.new(:configuration => config)
+
+      assert_equal(stack, deployment.stack)
+    end
+  end
+end

data/test/unit/model/stack_test.rb

@@ -0,0 +1,33 @@
+require 'test_helper'
+
+class StackTest < ActiveSupport::TestCase
+  describe 'validations' do
+    setup do
+      @valid_params = {
+        :name => 'stack1',
+        :definition => 'abc'
+      }
+    end
+
+    test 'valid attributes' do
+      s = ForemanDeployments::Stack.new(@valid_params)
+      assert(s.valid?)
+    end
+
+    test 'name must be unique' do
+      ForemanDeployments::Stack.create(@valid_params)
+      s = ForemanDeployments::Stack.new(@valid_params.except(:definition))
+      refute(s.valid?)
+    end
+
+    test 'name must be present' do
+      s = ForemanDeployments::Stack.new(@valid_params.except(:name))
+      refute(s.valid?)
+    end
+
+    test 'definition must be present' do
+      s = ForemanDeployments::Stack.new(@valid_params.except(:definition))
+      refute(s.valid?)
+    end
+  end
+end

metadata

@@ -0,0 +1,241 @@
+--- !ruby/object:Gem::Specification
+name: foreman_deployments
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Foreman Deployments team
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: foreman-tasks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.3
+- !ruby/object:Gem::Dependency
+  name: safe_yaml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A plugin adding Multi-Host Deployment support into the Foreman.
+email:
+- foreman-dev@googlegroups.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- app/controllers/foreman_deployments/api/v2/base_controller.rb
+- app/controllers/foreman_deployments/api/v2/deployments_controller.rb
+- app/controllers/foreman_deployments/api/v2/stacks_controller.rb
+- app/controllers/foreman_deployments/create_resources_controller.rb
+- app/controllers/foreman_deployments/deployments_controller.rb
+- app/controllers/foreman_deployments/stacks_controller.rb
+- app/lib/foreman_deployments/base_dereference_visitor.rb
+- app/lib/foreman_deployments/config.rb
+- app/lib/foreman_deployments/config/array.rb
+- app/lib/foreman_deployments/config/configurator.rb
+- app/lib/foreman_deployments/config/hash.rb
+- app/lib/foreman_deployments/config/load_visitor.rb
+- app/lib/foreman_deployments/config/merge_visitor.rb
+- app/lib/foreman_deployments/config/save_visitor.rb
+- app/lib/foreman_deployments/inputs/base_input_definition.rb
+- app/lib/foreman_deployments/inputs/value.rb
+- app/lib/foreman_deployments/planner_visitor.rb
+- app/lib/foreman_deployments/registry.rb
+- app/lib/foreman_deployments/stack_definition.rb
+- app/lib/foreman_deployments/stack_parser.rb
+- app/lib/foreman_deployments/task_reference.rb
+- app/lib/foreman_deployments/tasks/base_action.rb
+- app/lib/foreman_deployments/tasks/base_definition.rb
+- app/lib/foreman_deployments/tasks/creation_task_definition.rb
+- app/lib/foreman_deployments/tasks/host_creation_task_definition.rb
+- app/lib/foreman_deployments/tasks/search_task_definition.rb
+- app/lib/foreman_deployments/tasks/stack_deploy_action.rb
+- app/lib/foreman_deployments/tasks/wait_until_built_task_definition.rb
+- app/lib/foreman_deployments/validation/dereference_visitor.rb
+- app/lib/foreman_deployments/validation/remove_ids_visitor.rb
+- app/lib/foreman_deployments/validation/validation_error.rb
+- app/lib/foreman_deployments/validation/validation_result.rb
+- app/lib/foreman_deployments/validation/validation_visitor.rb
+- app/lib/foreman_deployments/validation/validator.rb
+- app/models/foreman_deployments/concerns/belongs_to_single_taxonomy.rb
+- app/models/foreman_deployments/concerns/belongs_to_stack_taxonomy.rb
+- app/models/foreman_deployments/configuration.rb
+- app/models/foreman_deployments/deployment.rb
+- app/models/foreman_deployments/resource_models/create_resource.rb
+- app/models/foreman_deployments/stack.rb
+- app/views/foreman_deployments/api/v2/deployments/base.json.rabl
+- app/views/foreman_deployments/api/v2/deployments/create.json.rabl
+- app/views/foreman_deployments/api/v2/deployments/index.json.rabl
+- app/views/foreman_deployments/api/v2/deployments/main.json.rabl
+- app/views/foreman_deployments/api/v2/deployments/merge_configuration.json.rabl
+- app/views/foreman_deployments/api/v2/deployments/replace_configuration.json.rabl
+- app/views/foreman_deployments/api/v2/deployments/run.json.rabl
+- app/views/foreman_deployments/api/v2/deployments/show.json.rabl
+- app/views/foreman_deployments/api/v2/deployments/update.json.rabl
+- app/views/foreman_deployments/api/v2/stacks/base.json.rabl
+- app/views/foreman_deployments/api/v2/stacks/create.json.rabl
+- app/views/foreman_deployments/api/v2/stacks/index.json.rabl
+- app/views/foreman_deployments/api/v2/stacks/main.json.rabl
+- app/views/foreman_deployments/api/v2/stacks/show.json.rabl
+- app/views/foreman_deployments/api/v2/stacks/update.json.rabl
+- app/views/foreman_deployments/create_resources/new.html.erb
+- config/routes.rb
+- db/migrate/20150623140612_create_stacks.rb
+- db/migrate/20150814092932_create_deployment.rb
+- db/migrate/20150916133305_add_task_to_deployments.rb
+- db/migrate/20150917130618_add_taxonomy_to_deployments.rb
+- db/seeds.d/03-permissions.rb
+- doc/deployment_process.md
+- doc/design/capsule_stack.puml
+- doc/design/complete_stack.puml
+- doc/design/config_resource_overview.puml
+- doc/design/design.md
+- doc/design/diagrams/capsule_stack.png
+- doc/design/diagrams/capsule_stack.svg
+- doc/design/diagrams/complete_stack.png
+- doc/design/diagrams/complete_stack.svg
+- doc/design/diagrams/config_resource_overview.png
+- doc/design/diagrams/config_resource_overview.svg
+- doc/design/diagrams/ordered_resource_overview.png
+- doc/design/diagrams/ordered_resource_overview.svg
+- doc/design/diagrams/overview.png
+- doc/design/diagrams/overview.svg
+- doc/design/diagrams/overview_class.png
+- doc/design/diagrams/overview_class.svg
+- doc/design/diagrams/sat_stack.png
+- doc/design/diagrams/sat_stack.svg
+- doc/design/diagrams/solr_usecase.png
+- doc/design/diagrams/solr_usecase.svg
+- doc/design/examples.md
+- doc/design/generate-diagrams.sh
+- doc/design/implementation.md
+- doc/design/ordered_resource_overview.puml
+- doc/design/overview.puml
+- doc/design/overview_class.puml
+- doc/design/resources.md
+- doc/design/sat_stack.puml
+- doc/design/shared.puml
+- doc/design/solr_usecase.puml
+- doc/design/tasks.md
+- doc/design/user_interfaces.md
+- doc/introduction.md
+- doc/writing_stacks.md
+- lib/foreman_deployments.rb
+- lib/foreman_deployments/engine.rb
+- lib/foreman_deployments/monkey_patches.rb
+- lib/foreman_deployments/version.rb
+- lib/tasks/foreman_deployments_tasks.rake
+- locale/Makefile
+- test/factories/foreman_deployments.rb
+- test/functional/api/v2/deployments_controller_test.rb
+- test/functional/api/v2/stacks_controller_test.rb
+- test/test_plugin_helper.rb
+- test/unit/lib/config/array_test.rb
+- test/unit/lib/config/configurator_test.rb
+- test/unit/lib/config/hash_test.rb
+- test/unit/lib/inputs/value_test.rb
+- test/unit/lib/registry_test.rb
+- test/unit/lib/stack_definition_test.rb
+- test/unit/lib/stack_parser_test.rb
+- test/unit/lib/task_reference_test.rb
+- test/unit/lib/tasks/base_definition_test.rb
+- test/unit/lib/tasks/creation_task_definition_test.rb
+- test/unit/lib/tasks/host_creation_task_definition_test.rb
+- test/unit/lib/tasks/search_task_definition_test.rb
+- test/unit/lib/tasks/stack_deploy_action_test.rb
+- test/unit/lib/tasks/wait_until_built_task_definition_test.rb
+- test/unit/lib/validation/dereference_visitor_test.rb
+- test/unit/lib/validation/remove_ids_visitor_test.rb
+- test/unit/lib/validation/validation_result_test.rb
+- test/unit/lib/validation/validation_visitor_test.rb
+- test/unit/model/configuration_test.rb
+- test/unit/model/deployment_test.rb
+- test/unit/model/stack_test.rb
+homepage: https://github.com/theforeman/foreman_deployments
+licenses: []
+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.4.8
+signing_key: 
+specification_version: 4
+summary: A plugin adding Multi-Host Deployment support into the Foreman.
+test_files:
+- test/factories/foreman_deployments.rb
+- test/functional/api/v2/deployments_controller_test.rb
+- test/functional/api/v2/stacks_controller_test.rb
+- test/unit/lib/stack_definition_test.rb
+- test/unit/lib/task_reference_test.rb
+- test/unit/lib/tasks/search_task_definition_test.rb
+- test/unit/lib/tasks/stack_deploy_action_test.rb
+- test/unit/lib/tasks/base_definition_test.rb
+- test/unit/lib/tasks/creation_task_definition_test.rb
+- test/unit/lib/tasks/host_creation_task_definition_test.rb
+- test/unit/lib/tasks/wait_until_built_task_definition_test.rb
+- test/unit/lib/validation/dereference_visitor_test.rb
+- test/unit/lib/validation/validation_result_test.rb
+- test/unit/lib/validation/validation_visitor_test.rb
+- test/unit/lib/validation/remove_ids_visitor_test.rb
+- test/unit/lib/config/configurator_test.rb
+- test/unit/lib/config/hash_test.rb
+- test/unit/lib/config/array_test.rb
+- test/unit/lib/registry_test.rb
+- test/unit/lib/stack_parser_test.rb
+- test/unit/lib/inputs/value_test.rb
+- test/unit/model/stack_test.rb
+- test/unit/model/configuration_test.rb
+- test/unit/model/deployment_test.rb
+- test/test_plugin_helper.rb