cbf 0.0.1

data/lib/parsers/aeolus_v1.rb

@@ -0,0 +1,169 @@
+# Copyright 2012 Red Hat, Inc.
+# Licensed under the Apache License, Version 2.0, see README for details.
+
+require 'nokogiri'
+
+module CBF
+  module Parsers
+    class AeolusV1
+      class << self
+
+        def parse(input_data, options)
+          begin
+            doc = Nokogiri::XML(input_data) { |config| config.strict.nonet }
+          rescue Nokogiri::XML::SyntaxError
+            raise SyntaxError
+          end
+          validate!(doc)
+
+          assemblies = (doc / 'assemblies/assembly').map { |a| parse_assembly(a)}
+          assembly_params = (doc / 'assemblies/assembly').map { |a| parse_assembly_parameters(a) }.flatten
+          resource_params = (doc / 'parameters/parameter').map { |el| parse_parameter(el) }
+          {
+            :name => doc.root.attr('name'),
+            :description => (doc % 'description').text,
+            :resources => assemblies,
+            :services => (doc / 'services/service').map { |el| parse_service(el) },
+            :parameters => assembly_params +  resource_params,
+            :files => (doc / '//executable|//files/file').map { |el| parse_file(el, resource_params) },
+            :outputs => (doc / 'assembly//return').map { |el| parse_return(el) },
+          }
+        end
+
+        private
+
+        def validate!(doc)
+          schema_path = File.join(File.dirname(__FILE__), 'aeolus_v1.rng.xml')
+          schema = Nokogiri::XML::RelaxNG(open(schema_path))
+          errors = schema.validate(doc) || []
+          raise ValidationError unless errors.empty?
+        end
+
+        def parse_assembly(assembly)
+          name = assembly['name']
+          {
+            :name => name,
+            :type => :instance,
+            :hardware_profile => {:parameter => 'hardware_profile'},
+            :image => {:parameter => 'image'},
+          }
+        end
+
+        def parse_assembly_parameters(assembly)
+          [
+            assembly_parameter('image', assembly['name'], (assembly % 'image')['id']),
+            assembly_parameter('hardware_profile', assembly['name'], assembly['hwp']),
+          ]
+        end
+
+        def assembly_parameter(name, assembly_name, default_value)
+          result = {
+            :type => :string,
+            :name => name,
+            :service => nil,
+            :resource => assembly_name,
+
+          }
+          result[:default] = default_value if default_value
+
+          result
+        end
+
+        def parse_service(service)
+          {
+            :name => service['name'],
+            :resource => service.ancestors('assembly').first['name'],
+          }
+        end
+
+        def parse_file(file, parameters)
+          assembly_name = file.ancestors('assembly').first['name']
+          service_name = file.ancestors('service').first['name']
+
+          result = {
+            :resource => assembly_name,
+            :service => service_name,
+            :location => File.join('/var/audrey/tooling/', service_name),
+            :owner => nil,
+            :group => nil,
+            :mode => '000644',
+            :executable => false,
+          }
+
+          url = file['url']
+          if url
+            result[:url] = url
+            result[:name] = File.basename(URI.parse(url).path)
+          else
+            contents = file % 'contents'
+            result[:name] = contents['name']
+            result[:contents] = contents.text
+          end
+
+          if file.name == 'executable'
+            result[:mode] = '000755'
+            result[:executable] = true
+            env_params = parameters.select do |p|
+              p[:resource] == assembly_name && p[:service] == service_name
+            end
+            result[:environment] = env_params.map do |p|
+              {
+                :name => "AUDREY_VAR_#{service_name}_#{p[:name]}",
+                :value => {:parameter =>  p[:name]},
+              }
+            end
+          end
+
+          result
+        end
+
+        def parse_parameter(parameter)
+          assembly_name = parameter.ancestors('assembly').first['name']
+          service_name = parameter.ancestors('service').first['name']
+          name = parameter['name']
+
+          result = {
+            :type => :string,
+            :name => name,
+            :service => service_name,
+            :resource => assembly_name,
+            :sensitive => false,
+          }
+
+          reference_el = parameter % 'reference'
+          if reference_el
+            result[:type] = :reference
+            result[:referenced_output] = {
+              :name => reference_el['parameter'],
+              :resource => reference_el['assembly'],
+            }
+            return result
+          end
+
+          value_el = parameter % 'value'
+          return result unless value_el
+
+          case value_el['type']
+          when 'scalar', nil, ''
+            result[:type] = :string
+          when 'password'
+            result[:type] = :string
+            result[:sensitive] = true
+          end
+          result[:default] = value_el.text
+
+          result
+        end
+
+        def parse_return(el)
+          {
+            :type => :facter,
+            :resource => el.ancestors('assembly').first['name'],
+            :name => el['name'],
+          }
+        end
+
+      end
+    end
+  end
+end

data/lib/parsers/aeolus_v1.rng.xml

@@ -0,0 +1,183 @@
+<!--
+
+   Copyright (C) 2011 Red Hat, Inc.
+   Written by Greg Blomquist <gblomqui@redhat.com>
+
+   Licensed to the Apache Software Foundation (ASF) under one or more
+   contributor license agreements.  See the NOTICE file distributed with
+   this work for additional information regarding copyright ownership.
+   The ASF licenses this file to You 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.
+
+-->
+
+<grammar xmlns="http://relaxng.org/ns/structure/1.0">
+
+  <start>
+    <element name="deployable">
+      <optional>
+        <!-- make the version attribute optional for backwards compat -->
+        <attribute name="version">
+          <choice>
+            <value>1.0</value>
+          </choice>
+        </attribute>
+      </optional>
+      <attribute name="name"><text/></attribute>
+      <optional>
+        <attribute name="id"><text/></attribute>
+      </optional>
+      <optional>
+        <element name="description"><text/></element>
+      </optional>
+      <ref name="assemblies-definition"/>
+    </element>
+  </start>
+
+  <!-- Each assembly describes an instance to launch as part of this deployable
+  -->
+  <define name="assemblies-definition">
+    <element name="assemblies">
+      <oneOrMore>
+        <element name="assembly">
+          <attribute name="name"><text/></attribute>
+          <!-- the hwp is the hardware profile that will be matched against a
+               provider -->
+          <attribute name="hwp"><text/></attribute>
+          <!-- the image id corresponds to an image warehouse image id -->
+          <element name="image">
+            <attribute name="id"><text/></attribute>
+            <optional>
+              <attribute name="build"><text/></attribute>
+            </optional>
+          </element>
+          <optional>
+            <ref name="services-definition"/>
+          </optional>
+          <optional>
+            <ref name="return-values-definition"/>
+          </optional>
+        </element>
+      </oneOrMore>
+    </element>
+  </define>
+
+  <!-- services describe the configuration that should be included in the
+       launched instance -->
+  <define name="services-definition">
+    <element name="services">
+      <oneOrMore>
+        <element name="service">
+          <attribute name="name"><text/></attribute>
+          <optional>
+            <element name="description"><text/></element>
+          </optional>
+          <ref name="service-configuration-definition"/>
+        </element>
+      </oneOrMore>
+    </element>
+  </define>
+
+  <!-- service describes the executable, additional files, and runtime
+       parameters that should be propagated to the launched instance -->
+  <define name="service-configuration-definition">
+    <ref name="configuration-executable-definition"/>
+    <optional>
+      <element name="files">
+        <oneOrMore>
+          <ref name="configuration-file-definition"/>
+        </oneOrMore>
+      </element>
+    </optional>
+    <optional>
+      <element name="parameters">
+        <oneOrMore>
+          <ref name="configuration-parameter-definition"/>
+        </oneOrMore>
+      </element>
+    </optional>
+  </define>
+
+  <define name="configuration-executable-definition">
+    <element name="executable">
+      <choice>
+        <attribute name="url"><text/></attribute>
+        <element name="contents"><text/></element>
+      </choice>
+    </element>
+  </define>
+
+  <define name="configuration-file-definition">
+    <element name="file">
+      <choice>
+        <attribute name="url"><text/></attribute>
+        <element name="contents">
+          <attribute name="filename"><text/></attribute>
+          <text/>
+        </element>
+      </choice>
+    </element>
+  </define>
+
+  <define name="configuration-parameter-definition">
+    <element name="parameter">
+      <attribute name="name"><text/></attribute>
+      <!-- type is deprecated here, it's proper use is on the value
+           tag. it can be removed is 1.2 -->
+      <optional>
+      <attribute name="type">
+        <choice>
+          <!-- only supporting scalar and password types for now -->
+          <value>scalar</value>
+          <!-- password types simply indicate that the UI collecting the
+               value should obscure the input field's value -->
+          <value>password</value>
+        </choice>
+      </attribute>
+      </optional>
+      <choice>
+        <empty/>
+        <element name="value">
+            <text/>
+            <optional>
+            <attribute name="type">
+              <choice>
+                <!-- only supporting scalar and password types for now -->
+                <value>scalar</value>
+                <!-- password types simply indicate that the UI collecting the
+                     value should obscure the input field's value -->
+                <value>password</value>
+              </choice>
+            </attribute>
+            </optional>
+        </element>
+        <element name="reference">
+          <attribute name="assembly"><text/></attribute>
+          <choice>
+            <attribute name="parameter"><text/></attribute>
+            <attribute name="service"><text/></attribute>
+          </choice>
+        </element>
+      </choice>
+    </element>
+  </define>
+
+  <define name="return-values-definition">
+    <element name="returns">
+      <oneOrMore>
+        <element name="return">
+          <attribute name="name"><text/></attribute>
+        </element>
+      </oneOrMore>
+    </element>
+  </define>
+</grammar>

data/spec/parsers/aeolus_v1_spec.rb

@@ -0,0 +1,63 @@
+# Copyright 2012 Red Hat, Inc.
+# Licensed under the Apache License, Version 2.0, see README for details.
+
+require 'spec_helper'
+require 'cbf'
+
+describe 'Aeolus deployable version 1 parser' do
+  it "must advertise the Aeolus version 1 format" do
+    CBF.parsers.must_include :aeolus_v1
+  end
+
+  it "must successfully parse the wordpress deployable" do
+    deployable_path = "#{SAMPLES_PATH}/aeolus_v1/wordpress.xml"
+    result = CBF.parse(:aeolus_v1, open(deployable_path))
+    result[:name].must_equal "Wordpress Multi-Instance Deployable"
+    result[:description].must_equal "This is an example of a multi deployment that deploys wordpress across an apache and mysql instance"
+
+    result[:resources].count.must_equal 2
+    result[:resources][0][:name].must_equal "webserver"
+    result[:resources][1][:name].must_equal "database"
+
+    result[:services].count.must_equal 2
+    result[:services][0][:name].must_equal "http"
+    result[:services][1][:name].must_equal "mysql"
+
+    http_params = result[:parameters].select do
+      |p| p[:resource] == "webserver" && p[:service] == "http"
+    end
+    http_params.count.must_equal 6
+
+    mysql_params = result[:parameters].select do
+      |p| p[:resource] == "database" && p[:service] == "mysql"
+    end
+    mysql_params.count.must_equal 5
+
+    result[:files].count.must_equal 3
+    result[:files].select { |f| f[:executable] }.count.must_equal 2
+
+    result[:outputs].count.must_equal 5
+  end
+
+  it "must successfully parse the drupal deployable" do
+    deployable_path = "#{SAMPLES_PATH}/aeolus_v1/drupal.xml"
+    CBF.parse(:aeolus_v1, open(deployable_path))
+  end
+
+  it "must successfully parse the sample deployable" do
+    deployable_path = "#{SAMPLES_PATH}/aeolus_v1/sample.xml"
+    CBF.parse(:aeolus_v1, open(deployable_path))
+  end
+
+  it "must fail for invalid XML" do
+    proc do
+      CBF.parse(:aeolus_v1, '<deployable')
+    end.must_raise CBF::SyntaxError
+  end
+
+  it "must fail for invalid Deployable format" do
+    proc do
+      CBF.parse(:aeolus_v1, '<deployable></deployable>')
+    end.must_raise CBF::ValidationError
+  end
+end

data/spec/samples/aeolus_v1/drupal.xml

@@ -0,0 +1,75 @@
+<deployable version="1.0" name="Drupal Multi-Instance Deployable">
+  <description>This is an example of a multi deployment that deploys drupal across an apache and mysql instance</description>
+  <assemblies>
+    <!-- The Drupal Assembly represents the instance that will be running apache
+         (httpd) with drupal7.-->
+    <assembly name="drupal" hwp="large">
+      <image id="DRUPAL_IMAGE_ID"/> <!-- replace your own image ID here -->
+      <services>
+        <service name="http">
+          <executable url="https://raw.github.com/aeolusproject/audrey/master/examples/drupal/drupal-http.py"/>
+          <files>
+            <file url="https://raw.github.com/aeolusproject/audrey/master/examples/drupal/settings.php"/>
+          </files>
+          <parameters>
+            <parameter name="db_name" type="scalar">
+                <value>drupal</value>
+            </parameter>
+            <parameter name="db_user" type="scalar">
+                <value>drupal</value>
+            </parameter>
+            <parameter name="db_pw" type="password">
+                <value>password</value>
+            </parameter>
+            <parameter name="db_ip" type="scalar">
+              <reference assembly="mysql" parameter="ipaddress"/>
+            </parameter>
+            <parameter name="db_hostname" type="scalar">
+              <reference assembly="mysql" parameter="hostname"/>
+            </parameter>
+            <parameter name="dbup" type="scalar">
+              <reference assembly="mysql" parameter="dbup"/>
+            </parameter>
+          </parameters>
+        </service>
+      </services>
+      <returns>
+        <return name="hostname"/>
+        <return name="ipaddress"/>
+      </returns>
+    </assembly>
+    <assembly name="mysql" hwp="large">
+      <image id="MYSQL_IMAGE_ID"/>
+      <services>
+        <service name="mysql">
+          <executable url="https://raw.github.com/aeolusproject/audrey/master/examples/drupal/drupal-mysql.py"/>
+          <files>
+            <file url="https://raw.github.com/aeolusproject/audrey/master/examples/drupal/dbup.rb"/>
+          </files>
+          <parameters>
+            <parameter name="db_name" type="scalar">
+                <value>drupal</value>
+            </parameter>
+            <parameter name="db_user" type="scalar">
+                <value>drupal</value>
+            </parameter>
+            <parameter name="db_pw" type="password">
+                <value>password</value>
+            </parameter>
+            <parameter name="apache_ip" type="scalar">
+              <reference assembly="drupal" parameter="ipaddress"/>
+            </parameter>
+            <parameter name="apache_hostname" type="scalar">
+              <reference assembly="drupal" parameter="hostname"/>
+            </parameter>
+          </parameters>
+        </service>
+      </services>
+      <returns>
+        <return name="hostname"/>
+        <return name="ipaddress"/>
+        <return name="dbup"/>
+      </returns>
+    </assembly>
+  </assemblies>
+</deployable>

data/spec/samples/aeolus_v1/sample.xml

@@ -0,0 +1,114 @@
+<!-- A deployable represents a set of instances to launch and configure at the
+     same time. -->
+<deployable version="1.0" name="multi-instance-multi-service">
+  <description>Deploys multiple instances with multiple services</description>
+  <assemblies>
+    <!-- When a deployable is launched, each assembly defition in this file
+         will map to a launched instance.
+         The assembly name should uniquely identify the assembly in this file.
+         The assembly "hwp" (hardware profile) should match a hardware profile
+         setup in Cloud Engine.-->
+    <assembly name="Instance-1" hwp="large">
+      <!-- This image element references an image that exists in the image
+           warehouse.
+           Images get into the image warehouse either by building the
+           image from a template XML file, or by importing from an
+           external source (such as an Amazon AMI). -->
+      <image id="INSERT IMAGE ID"/>
+      <services>
+        <!-- A "service" in a deployable is simply a way to group common
+             post-launch configurations together.
+             Each service contains:
+               - an executable script that performs the configuration
+               - parameters collected at launch time that are fed into the
+                 executable script by the Audrey Agent post-launch
+               - additional files that can be used by the executable script for
+                 configuring the guest -->
+        <service name="service1">
+          <!-- This is a URL that the Audrey Configuration Server must be
+               able to access, and points to a script that is meant to
+               setup the service.
+               The user will be responsible for authoring and providing
+               this script. -->
+          <executable url="https://www.aeolusproject.org/redmine/attachments/download/169/start_simple"/>
+          <!-- The parameters that are fed into the "start_simple" script
+               above are identified here in the "parameters" section. -->
+          <parameters>
+            <!-- Parameter values will be collected at launch time.
+                 The user launching the deployment will have an opportunity to
+                 provide values for all parameters, whether they have default
+                 values or not. -->
+            <!-- Only scalar parameter types are going to be supported
+                 initially. -->
+            <parameter name="service_1_param_1">
+              <!-- Default values can be provided directly in the deployable. -->
+              <value type="scalar"><![CDATA[value 1]]></value>
+            </parameter>
+            <parameter name="service_1_param_2"/>
+          </parameters>
+        </service>
+        <service name="service2">
+          <executable url="https://www.aeolusproject.org/redmine/attachments/download/169/start_simple"/>
+          <parameters>
+            <parameter name="service_2_param_1">
+              <value type="scalar"><![CDATA[value 1]]></value>
+            </parameter>
+            <parameter name="service_2_param_2">
+              <value type="scalar"><![CDATA[value 2]]></value>
+            </parameter>
+          </parameters>
+        </service>
+      </services>
+      <!-- The elements listed under the "returns" element are values that
+           are collected by the launched guest and returned to the
+           configuration server.
+           The values that are returned to the configuration server can be
+           shared with other launched instances in this deployable. -->
+      <returns>
+        <return name="hostname"/>
+      </returns>
+    </assembly>
+    <assembly name="Instance-2" hwp="large">
+      <image id="INSERT IMAGE ID"/>
+      <services>
+        <service name="service3">
+          <executable>
+            <contents><![CDATA[#!/bin/bash
+echo hello, world!
+]]></contents>
+          </executable>
+          <files>
+            <file url="http://example.com/file" />
+            <file>
+              <contents filename="thingy.conf"><![CDATA[name: hello]]></contents>
+            </file>
+          </files>
+          <parameters>
+            <parameter name="service_3_param_1">
+              <value type="scalar"><![CDATA[value 1]]></value>
+            </parameter>
+            <parameter name="service_3_param_2">
+              <value type="scalar"><![CDATA[value 2]]></value>
+            </parameter>
+          </parameters>
+        </service>
+        <service name="service4">
+          <executable url="https://www.aeolusproject.org/redmine/attachments/download/169/start_simple"/>
+          <parameters>
+            <parameter name="service_4_param_1">
+              <value type="scalar"><![CDATA[value 1]]></value>
+            </parameter>
+            <!-- Parameters can also reference "returns" from other assemblies.
+                 In this example, Instance-2 requests the "hostname" return value from Instance-1. -->
+            <parameter name="service_4_param_2">
+              <reference assembly="Instance-1" parameter="hostname"/>
+            </parameter>
+          </parameters>
+        </service>
+      </services>
+      <returns>
+        <return name="hostname"/>
+      </returns>
+    </assembly>
+  </assemblies>
+</deployable>

data/spec/samples/aeolus_v1/wordpress.xml

@@ -0,0 +1,79 @@
+<deployable name="Wordpress Multi-Instance Deployable">
+  <description>This is an example of a multi deployment that deploys wordpress across an apache and mysql instance</description>
+  <assemblies>
+    <assembly hwp="small-x86_64" name="webserver">
+      <image id="APACHE_IMAGE_ID"/>
+      <services>
+        <service name="http">
+          <!-- This script file is executed on the Apache node, after the MySQL node -->
+          <!-- finishes running it's database setup script (as per comments below in -->
+          <!-- its section).  On this node, the script runs Wordpress's installer,   -->
+          <!-- giving it the MySQL database connection details, and some other basic -->
+          <!-- parameters. -->
+          <executable url="https://raw.github.com/aeolusproject/audrey/master/examples/wordpress/wordpress-http.sh"/>
+          <parameters>
+            <parameter name="wp_name">
+                <value>wordpress</value>
+            </parameter>
+            <parameter name="wp_user">
+                <value>wordpress</value>
+            </parameter>
+            <parameter name="wp_pw">
+                <value type="password">wordpress</value>
+            </parameter>
+            <parameter name="mysql_ip">
+              <reference assembly="mysql" parameter="ipaddress"/>
+            </parameter>
+            <parameter name="mysql_hostname">
+              <reference assembly="mysql" parameter="hostname"/>
+            </parameter>
+            <parameter name="mysql_dbup">
+              <reference assembly="mysql" parameter="dbup"/>
+            </parameter>
+          </parameters>
+        </service>
+      </services>
+      <returns>
+        <return name="hostname"/>
+        <return name="ipaddress"/>
+      </returns>
+    </assembly>
+    <assembly hwp="small-x86_64" name="database">
+      <image id="MYSQL_IMAGE_ID"/>
+      <services>
+        <service name="mysql">
+          <!-- This script file is executed on the MySQL node.  It creates the "wordpress" -->
+          <!-- user in the MySQL database, and an empty "wordpress" database owned by it.  -->
+          <!-- When this script has finished, Audrey then goes on to configure the apache  -->
+          <!-- node (above). -->
+          <executable url="https://raw.github.com/aeolusproject/audrey/master/examples/wordpress/wordpress-mysql.sh"/>
+          <files>
+            <file url="https://raw.github.com/aeolusproject/audrey/master/examples/wordpress/dbup.rb"/>
+          </files>
+          <parameters>
+            <parameter name="wp_name">
+                <value>wordpress</value>
+            </parameter>
+            <parameter name="wp_user">
+                <value>wordpress</value>
+            </parameter>
+            <parameter name="wp_pw">
+                <value type="password">wordpress</value>
+            </parameter>
+            <parameter name="apache_ip">
+              <reference assembly="apache" parameter="ipaddress"/>
+            </parameter>
+            <parameter name="apache_hostname">
+              <reference assembly="apache" parameter="hostname"/>
+            </parameter>
+          </parameters>
+        </service>
+      </services>
+      <returns>
+        <return name="hostname"/>
+        <return name="ipaddress"/>
+        <return name="dbup"/>
+      </returns>
+    </assembly>
+  </assemblies>
+</deployable>