unless ENV['BEAKER_provision'] == 'no'
hosts.each do |host|
# Install Puppet
- if host.is_pe?
- install_pe
- else
- install_puppet
- end
+ install_puppet_agent_on(host, puppet_collection: "pc1")
end
end
puppet_module_install(:source => proj_root, :module_name => 'opendaylight')
hosts.each do |host|
# Install stdlib, a dependency of the odl mod
- # TODO: Why is 1 an acceptable exit code?
- on host, puppet('module', 'install', 'puppetlabs-stdlib'), { :acceptable_exit_codes => [0,1] }
- # Install archive, a dependency of the odl mod use for tarball-type installs
- # TODO: I'd prefer not to use gini-archive. See:
- # https://github.com/dfarrell07/puppet-opendaylight/issues/52
- on host, puppet('module', 'install', 'gini-archive'), { :acceptable_exit_codes => [0] }
- # Required by tarball install method
- on host, puppet('module', 'install', 'puppetlabs-java'), { :acceptable_exit_codes => [0] }
+ on host, puppet('module', 'install', 'puppetlabs-stdlib'), { :acceptable_exit_codes => [0] }
+ # Install apt, a dependency of the deb install method
+ on host, puppet('module', 'install', 'puppetlabs-apt'), { :acceptable_exit_codes => [0] }
end
end
end
# NB: These are a library of helper fns used by the Beaker tests
#
+# NB: There are a large number of helper functions used in these tests.
+# They make this code much more friendly, but may need to be referenced.
+# The serverspec helpers (`should`, `be_running`...) are documented here:
+# http://serverspec.org/resource_types.html
+
def install_odl(options = {})
+ # Install params are passed via environment var, set in Rakefile
+ # Changing the installed version of ODL via `puppet apply` is not supported
+ # by puppet-odl, so it's not possible to vary these params in the same
+ # Beaker test run. Do a different run passing different env vars.
+ rpm_repo = ENV['RPM_REPO']
+ deb_repo = ENV['DEB_REPO']
+
# NB: These param defaults should match the ones used by the opendaylight
# class, which are defined in opendaylight::params
# TODO: Remove this possible source of bugs^^
# Extract params if given, defaulting to odl class defaults if not
- install_method = options.fetch(:install_method, 'rpm')
- extra_features = options.fetch(:extra_features, [])
- default_features = options.fetch(:default_features, ['config', 'standard', 'region',
- 'package', 'kar', 'ssh', 'management'])
+ extra_features = options.fetch(:extra_features, ['odl-restconf'])
+ default_features = options.fetch(:default_features, ['standard', 'wrap', 'ssh'])
+ odl_rest_port = options.fetch(:odl_rest_port, 8181)
+ odl_bind_ip = options.fetch(:odl_bind_ip, '0.0.0.0')
+ log_levels = options.fetch(:log_levels, {})
+ enable_ha = options.fetch(:enable_ha, false)
+ ha_node_ips = options.fetch(:ha_node_ips, [])
+ ha_node_index = options.fetch(:ha_node_index, 0)
+ ha_db_modules = options.fetch(:ha_db_modules, { 'default' => false })
+ username = options.fetch(:username, 'admin')
+ password = options.fetch(:password, 'admin')
+ log_max_size = options.fetch(:log_max_size, '10GB')
+ log_max_rollover = options.fetch(:log_max_rollover, 2)
+ snat_mechanism = options.fetch(:snat_mechanism, 'controller')
+ enable_tls = options.fetch(:enable_tls, false)
+ tls_keystore_password = options.fetch(:tls_keystore_password, 'dummypass')
+ log_mechanism = options.fetch(:log_mechanism, 'file')
# Build script for consumption by Puppet apply
it 'should work idempotently with no errors' do
pp = <<-EOS
class { 'opendaylight':
- install_method => #{install_method},
+ rpm_repo => '#{rpm_repo}',
+ deb_repo => '#{deb_repo}',
default_features => #{default_features},
extra_features => #{extra_features},
+ odl_rest_port => #{odl_rest_port},
+ odl_bind_ip => '#{odl_bind_ip}',
+ enable_ha => #{enable_ha},
+ ha_node_ips => #{ha_node_ips},
+ ha_node_index => #{ha_node_index},
+ ha_db_modules => #{ha_db_modules},
+ log_levels => #{log_levels},
+ username => #{username},
+ password => #{password},
+ log_max_size => '#{log_max_size}',
+ log_max_rollover => #{log_max_rollover},
+ snat_mechanism => #{snat_mechanism},
+ enable_tls => #{enable_tls},
+ tls_keystore_password => #{tls_keystore_password},
+ log_mechanism => #{log_mechanism},
}
EOS
- # TODO: Apply to host selectively based on install method
-
- # Run it twice and test for idempotency
+ # Apply our Puppet manifest on the Beaker host
apply_manifest(pp, :catch_failures => true)
- apply_manifest(pp, :catch_changes => true)
- end
+
+ # Not checking for idempotence because of false failures
+ # related to package manager cache updates outputting to
+ # stdout and different IDs for the puppet manifest apply.
+ # I think this is a limitation in how Beaker can check
+ # for changes, not a problem with the Puppet module.
+ end
end
# Shared function that handles generic validations
# These should be common for all odl class param combos
def generic_validations()
- # TODO: It'd be nice to do this independently of install dir name
- describe file('/opt/opendaylight-0.2.2/') do
+ # Verify ODL's directory
+ describe file('/opt/opendaylight/') do
it { should be_directory }
it { should be_owned_by 'odl' }
it { should be_grouped_into 'odl' }
- it { should be_mode '775' }
end
+ # Verify ODL's systemd service
describe service('opendaylight') do
it { should be_enabled }
it { should be_enabled.with_level(3) }
- it { should be_running }
- end
-
- # OpenDaylight will appear as a Java process
- describe process('java') do
- it { should be_running }
+ it { should be_running.under('systemd') }
end
- # TODO: It'd be nice to do this independently of install dir name
+ # Creation handled by RPM or Deb
describe user('odl') do
it { should exist }
it { should belong_to_group 'odl' }
- it { should have_home_directory '/opt/opendaylight-0.2.2' }
+ # NB: This really shouldn't have a slash at the end!
+ # The home dir set by the RPM is `/opt/opendaylight`.
+ # Since we use the trailing slash elsewhere else, this
+ # may look like a style issue. It isn't! It will make
+ # Beaker tests fail if it ends with a `/`. A future
+ # version of the ODL RPM may change this.
+ it { should have_home_directory '/opt/opendaylight' }
+ end
+
+ # Creation handled by RPM or Deb
+ describe group('odl') do
+ it { should exist }
end
+ # This should not be the odl user's home dir
describe file('/home/odl') do
# Home dir shouldn't be created for odl user
it { should_not be_directory }
end
- describe file('/usr/lib/systemd/system/opendaylight.service') do
+ # OpenDaylight will appear as a Java process
+ describe process('java') do
+ it { should be_running }
+ end
+
+ # Should contain Karaf features config file
+ describe file('/opt/opendaylight/etc/org.apache.karaf.features.cfg') do
+ it { should be_file }
+ it { should be_owned_by 'odl' }
+ it { should be_grouped_into 'odl' }
+ end
+
+ # Should contain ODL NB port config file
+ describe file('/opt/opendaylight/etc/jetty.xml') do
it { should be_file }
- it { should be_owned_by 'root' }
- it { should be_grouped_into 'root' }
- it { should be_mode '644' }
+ it { should be_owned_by 'odl' }
+ it { should be_grouped_into 'odl' }
+ end
+
+ # Should contain log level config file
+ describe file('/opt/opendaylight/etc/org.ops4j.pax.logging.cfg') do
+ it { should be_file }
+ it { should be_owned_by 'odl' }
+ it { should be_grouped_into 'odl' }
+ end
+
+ if ['centos-7', 'centos-7-docker'].include? ENV['RS_SET']
+ # Validations for modern Red Hat family OSs
+
+ # Verify ODL systemd .service file
+ describe file('/usr/lib/systemd/system/opendaylight.service') do
+ it { should be_file }
+ it { should be_owned_by 'root' }
+ it { should be_grouped_into 'root' }
+ it { should be_mode '644' }
+ end
+
+ # Java 8 should be installed
+ describe package('java-1.8.0-openjdk') do
+ it { should be_installed }
+ end
+
+ # Ubuntu 16.04 specific validation
+ elsif ['ubuntu-16', 'ubuntu-16-docker'].include? ENV['RS_SET']
+
+ # Verify ODL systemd .service file
+ describe file('/lib/systemd/system/opendaylight.service') do
+ it { should be_file }
+ it { should be_owned_by 'root' }
+ it { should be_grouped_into 'root' }
+ it { should be_mode '644' }
+ end
+
+ # Java 8 should be installed
+ describe package('openjdk-8-jre-headless') do
+ it { should be_installed }
+ end
+
+ else
+ fail("Unexpected RS_SET (host OS): #{ENV['RS_SET']}")
+ end
+end
+
+# Shared function for validations related to log file settings
+def log_settings_validations(options = {})
+ # Should contain log level config file with correct file size and rollover values
+ log_max_size = options.fetch(:log_max_size, '10GB')
+ log_max_rollover = options.fetch(:log_max_rollover, 2)
+ log_mechanism = options.fetch(:log_mechanism, 'file')
+
+ if log_mechanism == 'console'
+ describe file('/opt/opendaylight/etc/org.ops4j.pax.logging.cfg') do
+ it { should be_file }
+ it { should be_owned_by 'odl' }
+ it { should be_grouped_into 'odl' }
+ its(:content) { should match /^karaf.log.console=INFO/ }
+ end
+ else
+ describe file('/opt/opendaylight/etc/org.ops4j.pax.logging.cfg') do
+ it { should be_file }
+ it { should be_owned_by 'odl' }
+ it { should be_grouped_into 'odl' }
+ its(:content) { should match /^log4j2.appender.rolling.policies.size.size = #{log_max_size}/ }
+ its(:content) { should match /^log4j2.appender.rolling.strategy.type = DefaultRolloverStrategy/ }
+ its(:content) { should match /^log4j2.appender.rolling.strategy.max = #{log_max_rollover}/ }
+ end
end
end
# class, which are defined in opendaylight::params
# TODO: Remove this possible source of bugs^^
extra_features = options.fetch(:extra_features, [])
- default_features = options.fetch(:default_features, ['config', 'standard', 'region',
- 'package', 'kar', 'ssh', 'management'])
+ default_features = options.fetch(:default_features, ['standard', 'wrap', 'ssh'])
# Create one list of all of the features
features = default_features + extra_features
- # TODO: It'd be nice to do this independently of install dir name
- describe file('/opt/opendaylight-0.2.2/etc/org.apache.karaf.features.cfg') do
+ describe file('/opt/opendaylight/etc/org.apache.karaf.features.cfg') do
it { should be_file }
it { should be_owned_by 'odl' }
it { should be_grouped_into 'odl' }
- it { should be_mode '775' }
its(:content) { should match /^featuresBoot=#{features.join(",")}/ }
end
end
+# Shared function for validations related to the ODL REST port config file
+def port_config_validations(options = {})
+ # NB: This param default should match the one used by the opendaylight
+ # class, which is defined in opendaylight::params
+ # TODO: Remove this possible source of bugs^^
+ odl_rest_port = options.fetch(:odl_rest_port, 8181)
+
+ describe file('/opt/opendaylight/etc/jetty.xml') do
+ it { should be_file }
+ it { should be_owned_by 'odl' }
+ it { should be_grouped_into 'odl' }
+ its(:content) { should match /Property name="jetty.port" default="#{odl_rest_port}"/ }
+ end
+end
+
+# Shared function for validations related to custom logging verbosity
+def log_level_validations(options = {})
+ # NB: This param default should match the one used by the opendaylight
+ # class, which is defined in opendaylight::params
+ # TODO: Remove this possible source of bugs^^
+ log_levels = options.fetch(:log_levels, {})
+
+ if log_levels.empty?
+ # Should contain log level config file
+ describe file('/opt/opendaylight/etc/org.ops4j.pax.logging.cfg') do
+ it { should be_file }
+ it { should be_owned_by 'odl' }
+ it { should be_grouped_into 'odl' }
+ end
+ else
+ # Should contain log level config file
+ describe file('/opt/opendaylight/etc/org.ops4j.pax.logging.cfg') do
+ it { should be_file }
+ it { should be_owned_by 'odl' }
+ it { should be_grouped_into 'odl' }
+ end
+ # Verify each custom log level config entry
+ log_levels.each_pair do |logger, level|
+ underscored_version = "#{logger}".gsub('.', '_')
+ describe file('/opt/opendaylight/etc/org.ops4j.pax.logging.cfg') do
+ it { should be_file }
+ it { should be_owned_by 'odl' }
+ it { should be_grouped_into 'odl' }
+ its(:content) { should match /^log4j2.logger.#{underscored_version}.level = #{level}/ }
+ its(:content) { should match /^log4j2.logger.#{underscored_version}.name = #{logger}/ }
+ end
+ end
+ end
+end
+
+# Shared function for validations related to ODL OVSDB HA config
+def enable_ha_validations(options = {})
+ # NB: This param default should match the one used by the opendaylight
+ # class, which is defined in opendaylight::params
+ # TODO: Remove this possible source of bugs^^
+ enable_ha = options.fetch(:enable_ha, false)
+ ha_node_ips = options.fetch(:ha_node_ips, [])
+ odl_bind_ip = options.fetch(:odl_bind_ip, '0.0.0.0')
+ ha_db_modules = options.fetch(:ha_db_modules, { 'default' => false })
+ # HA_NODE_IPS size
+ ha_node_count = ha_node_ips.size
+
+ if (enable_ha) && (ha_node_count < 2)
+ # Check for HA_NODE_COUNT < 2
+ fail("Number of HA nodes less than 2: #{ha_node_count} and HA Enabled")
+ end
+
+ if enable_ha
+ ha_node_index = ha_node_ips.index(odl_bind_ip)
+ describe file('/opt/opendaylight/configuration/initial/akka.conf') do
+ it { should be_file }
+ it { should be_owned_by 'odl' }
+ it { should be_grouped_into 'odl' }
+ its(:content) { should match /roles\s*=\s*\["member-#{ha_node_index}"\]/ }
+ end
+
+ ha_db_modules.each do |mod, urn|
+ describe file('/opt/opendaylight/configuration/initial/module-shards.conf') do
+ it { should be_file }
+ it { should be_owned_by 'odl' }
+ it { should be_grouped_into 'odl' }
+ its(:content) { should match /name = "#{mod}"/ }
+ end
+
+ if mod == 'default'
+ describe file('/opt/opendaylight/configuration/initial/modules.conf') do
+ it { should be_file }
+ it { should be_owned_by 'odl' }
+ it { should be_grouped_into 'odl' }
+ end
+ else
+ describe file('/opt/opendaylight/configuration/initial/modules.conf') do
+ it { should be_file }
+ it { should be_owned_by 'odl' }
+ it { should be_grouped_into 'odl' }
+ its(:content) { should match /name = "#{mod}"/ }
+ its(:content) { should match /namespace = "#{urn}"/ }
+ end
+ end
+ end
+ end
+end
+
# Shared function that handles validations specific to RPM-type installs
def rpm_validations()
+ rpm_repo = ENV['RPM_REPO']
+
describe yumrepo('opendaylight') do
it { should exist }
it { should be_enabled }
it { should be_installed }
end
end
+
+# Shared function that handles validations specific to Deb-type installs
+def deb_validations()
+ deb_repo = ENV['DEB_REPO']
+ # Check ppa
+ # Docs: http://serverspec.org/resource_types.html#ppa
+ describe ppa(deb_repo) do
+ it { should exist }
+ it { should be_enabled }
+ end
+
+ describe package('opendaylight') do
+ it { should be_installed }
+ end
+end
+
+# Shared function for validations related to username/password
+def username_password_validations(options = {})
+ # NB: This param default should match the one used by the opendaylight
+ # class, which is defined in opendaylight::params
+ # TODO: Remove this possible source of bugs^^
+ odl_username = options.fetch(:username, 'admin')
+ odl_password = options.fetch(:password, 'admin')
+ odl_check_url = 'http://127.0.0.1:8181/restconf'
+
+ describe file('/opt/opendaylight/data/idmlight.db.mv.db') do
+ it { should be_file }
+ end
+
+ describe command("loop_count=0; until [[ \$loop_count -ge 300 ]]; do curl -o /dev/null --fail --silent --head -u #{odl_username}:#{odl_password} #{odl_check_url} && break; loop_count=\$[\$loop_count+1]; sleep 1; done; echo \"Waited \$loop_count seconds for ODL to become active\"") do
+ its(:exit_status) { should eq 0 }
+ end
+
+ describe command("curl -o /dev/null --fail --silent --head -u #{odl_username}:#{odl_password} #{odl_check_url}") do
+ its(:exit_status) { should eq 0 }
+ end
+end
+
+# Shared function for validations related to the SNAT config file
+def snat_mechanism_validations(options = {})
+ # NB: This param default should match the one used by the opendaylight
+ # class, which is defined in opendaylight::params
+ # TODO: Remove this possible source of bugs^^
+ snat_mechanism = options.fetch(:snat_mechanism, 'controller')
+
+ describe file('/opt/opendaylight/etc/opendaylight/datastore/initial/config/netvirt-natservice-config.xml') do
+ it { should be_file }
+ it { should be_owned_by 'odl' }
+ it { should be_grouped_into 'odl' }
+ its(:content) { should match /<nat-mode>#{snat_mechanism}<\/nat-mode>/ }
+ end
+end
+
+# Shared function for validations related to SFC
+def sfc_validations()
+ # NB: This param default should match the one used by the opendaylight
+ # class, which is defined in opendaylight::params
+ # TODO: Remove this possible source of bugs^^
+
+ describe file('/opt/opendaylight/etc/opendaylight/datastore/initial/config/netvirt-elanmanager-config.xml') do
+ it { should be_file }
+ it { should be_owned_by 'odl' }
+ it { should be_grouped_into 'odl' }
+ its(:content) { should match /<use-of-tunnels>true<\/use-of-tunnels>/ }
+ end
+
+ describe file('/opt/opendaylight/etc/opendaylight/datastore/initial/config/genius-itm-config.xml') do
+ it { should be_file }
+ it { should be_owned_by 'odl' }
+ it { should be_grouped_into 'odl' }
+ its(:content) { should match /<gpe-extension-enabled>true<\/gpe-extension-enabled>/ }
+ end
+end
+
+def websocket_address_validations(options = {})
+ # NB: This param default should match the one used by the opendaylight
+ # class, which is defined in opendaylight::params
+ # TODO: Remove this possible source of bugs^^
+ odl_bind_ip = options.fetch(:odl_bind_ip, '0.0.0.0')
+
+ if not odl_bind_ip.eql? '0.0.0.0'
+ describe file('/opt/opendaylight/etc/org.opendaylight.restconf.cfg') do
+ it { should be_file }
+ it { should be_owned_by 'odl' }
+ it { should be_grouped_into 'odl' }
+ its(:content) { should match /^websocket-address=#{odl_bind_ip}/ }
+ end
+ else
+ describe file('/opt/opendaylight/etc/org.opendaylight.restconf.cfg') do
+ it { should be_file }
+ end
+ end
+end
+
+def tls_validations(options = {})
+ # NB: This param default should match the one used by the opendaylight
+ # class, which is defined in opendaylight::params
+ # TODO: Remove this possible source of bugs^^
+ tls_keystore_password = options.fetch(:tls_keystore_password)
+ odl_rest_port = options.fetch(:odl_rest_port, 8181)
+
+ describe file('/opt/opendaylight/etc/org.ops4j.pax.web.cfg') do
+ it { should be_file }
+ it { should be_owned_by 'odl' }
+ it { should be_grouped_into 'odl' }
+ its(:content) { should match /org.osgi.service.http.port.secure = #{odl_rest_port}/ }
+ its(:content) { should match /org.ops4j.pax.web.ssl.keystore = configuration\/ssl\/ctl.jks/ }
+ its(:content) { should match /org.ops4j.pax.web.ssl.password = #{tls_keystore_password}/ }
+ its(:content) { should match /org.ops4j.pax.web.ssl.keypassword = #{tls_keystore_password}/ }
+ its(:content) { should match /org.osgi.service.http.secure.enabled = true/ }
+ end
+
+ describe file('/opt/opendaylight/etc/org.opendaylight.ovsdb.library.cfg') do
+ it { should be_file }
+ it { should be_owned_by 'odl' }
+ it { should be_grouped_into 'odl' }
+ its(:content) { should match /use-ssl = true/ }
+ end
+
+ describe file('/opt/opendaylight/etc/opendaylight/datastore/initial/config/default-openflow-connection-config.xml') do
+ it { should be_file }
+ it { should be_owned_by 'odl' }
+ it { should be_grouped_into 'odl' }
+ its(:content) { should match /<keystore-password>#{tls_keystore_password}<\/keystore-password>/ }
+ its(:content) { should match /<truststore-password>#{tls_keystore_password}<\/truststore-password>/ }
+ its(:content) { should match /<transport-protocol>TLS<\/transport-protocol>/ }
+ end
+
+ describe file('/opt/opendaylight/etc/opendaylight/datastore/initial/config/aaa-cert-config.xml') do
+ it { should be_file }
+ it { should be_owned_by 'odl' }
+ it { should be_grouped_into 'odl' }
+ its(:content) { should match /<store-password>#{tls_keystore_password}<\/store-password>/ }
+ its(:content) { should match /<use-mdsal>false<\/use-mdsal>/ }
+ end
+
+ describe file('/opt/opendaylight/etc/jetty.xml') do
+ it { should be_file }
+ it { should be_owned_by 'odl' }
+ it { should be_grouped_into 'odl' }
+ its(:content) { should match /<Property name="jetty.secure.port" default="#{odl_rest_port}" \/>/ }
+ end
+end