Merge pull request #44 from bstopp/feature/pre-install-configs

OSGi Configuration Support

Author: bstopp

.travis.yml

@@ -2,8 +2,8 @@ language: ruby
 rvm:
  - "1.9.3"
  - "2.0.0"
- - "2.1.5"
- - "2.2.1"
+ - "2.1.7"
+ - "2.2.3"
 
 env:
  - CODECLIMATE_REPO_TOKEN="c51cdd016a53f48b9e48d81fc67fed1fd4310fcbdd35daf0f3694ff5d54637f7"

Gemfile

@@ -1,10 +1,11 @@
 source ENV['GEM_SOURCE'] || 'https://rubygems.org'
 
 group :development, :tests do
-  gem 'rspec', '~> 3.3',           :require => false
+  gem 'rspec', '~> 3.4',           :require => false
   gem 'rake',                      :require => false
   gem 'metadata-json-lint',        :require => false
   gem 'rspec-puppet',              :require => false
+  gem 'webmock',                   :require => false
   gem 'puppetlabs_spec_helper',    :require => false
   gem 'codeclimate-test-reporter', :require => false
 end
@@ -15,7 +16,7 @@ group :linting do
 end
 
 group :system_tests do
-  gem 'beaker', '~>2.18',               :require => false
+  gem 'beaker', '~>2.31',               :require => false
   gem 'beaker-rspec',                   :require => false
   gem 'serverspec',                     :require => false
   gem 'beaker-puppet_install_helper', '>= 0.2.1', :require => false

Gemfile.lock

@@ -57,6 +57,8 @@ GEM
     builder (3.2.2)
     codeclimate-test-reporter (0.4.8)
       simplecov (>= 0.7.1, < 1.0.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
     diff-lcs (1.2.5)
     docile (1.1.5)
     docker-api (1.24.1)
@@ -142,7 +144,7 @@ GEM
       fog-core
       fog-json
       fog-xml
-    fog-sakuracloud (1.7.3)
+    fog-sakuracloud (1.7.5)
       fog-core
       fog-json
     fog-serverlove (0.1.2)
@@ -185,6 +187,7 @@ GEM
       memoist (~> 0.12)
       multi_json (~> 1.11)
       signet (~> 0.7)
+    hashdiff (0.2.3)
     hiera (3.0.5)
       json_pure
     hocon (0.9.3)
@@ -271,6 +274,7 @@ GEM
       ruby-progressbar (~> 1.7)
       tins (<= 1.6.0)
     ruby-progressbar (1.7.5)
+    safe_yaml (1.0.4)
     serverspec (2.25.0)
       multi_json
       rspec (~> 3.0)
@@ -303,12 +307,16 @@ GEM
     unf (0.1.4)
       unf_ext
     unf_ext (0.0.7.1)
+    webmock (1.22.3)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  beaker (~> 2.18)
+  beaker (~> 2.31)
   beaker-puppet_install_helper (>= 0.2.1)
   beaker-rspec
   codeclimate-test-reporter
@@ -318,10 +326,11 @@ DEPENDENCIES
   puppet-lint
   puppetlabs_spec_helper
   rake
-  rspec (~> 3.3)
+  rspec (~> 3.4)
   rspec-puppet
   rubocop
   serverspec
+  webmock
 
 BUNDLED WITH
    1.11.2

README.md

@@ -1,4 +1,3 @@
-[Overview]: #overview
 
 [Module Description]: #module-description
 
@@ -22,6 +21,7 @@
 [Adobe]: http://www.adobe.com
 [Adobe Experience Manager]: http://www.adobe.com/marketing-cloud/enterprise-content-management.html
 
+[Felix Configuration]: http://felix.apache.org/documentation/subprojects/apache-felix-config-admin.html
 
 [Sling launchpad]: https://sling.apache.org/documentation/the-sling-engine/the-sling-launchpad.html
 [Sling command-line-options]: https://sling.apache.org/documentation/the-sling-engine/the-sling-launchpad.html#command-line-options
@@ -31,23 +31,25 @@
 [AEM Installation Runmodes]: https://docs.adobe.com/docs/en/aem/6-1/deploy/configuring/configure-runmodes.html#Installation%20Run%20Modes
 [AEM Java Requirements]: https://docs.adobe.com/docs/en/aem/6-1/deploy/technical-requirements.html#Java%20Virtual%20Machines
 
+# aem - Adobe Experience Manager
+[![Puppet Forge Version](https://img.shields.io/puppetforge/v/bstopp/aem.svg)](https://forge.puppetlabs.com/bstopp/aem)
+[![Puppet Forge Downloads](https://img.shields.io/puppetforge/dt/bstopp/aem.svg)](https://forge.puppetlabs.com/bstopp/aem)
 [![Build Status](https://travis-ci.org/bstopp/puppet-aem.svg?branch=master)](https://travis-ci.org/bstopp/puppet-aem)
 [![Dependency Status](https://gemnasium.com/bstopp/puppet-aem.svg)](https://gemnasium.com/bstopp/puppet-aem)
 [![Code Climate](https://codeclimate.com/github/bstopp/puppet-aem/badges/gpa.svg)](https://codeclimate.com/github/bstopp/puppet-aem)
 [![Test Coverage](https://codeclimate.com/github/bstopp/puppet-aem/badges/coverage.svg)](https://codeclimate.com/github/bstopp/puppet-aem/coverage)
-
-# aem - Adobe Experience Manager
+[![Join the chat at https://gitter.im/bstopp/puppet-aem](https://badges.gitter.im/bstopp/puppet-aem.svg)](https://gitter.im/bstopp/puppet-aem?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
 #### Table of Contents
 
 1. [Module Description - What does the module do?][Module Description]
 1. [Setup - The basics of getting started with AEM module][Setup]
-    * [Setup Requirements][]
-    * [Beginning with AEM][]
+  * [Setup Requirements][]
+  * [Beginning with AEM][]
 1. [Reference - AEM Module type and providers][Reference]
-    * [Public Defines][]
-    * [Private Defines][]
-    * [Private Types][]
+  * [Public Defines][]
+  * [Private Defines][]
+  * [Private Types][]
 1. [Limitations - OS compatibility, etc.][Limitations]
 1. [Development - Contributing to the module][Development]
 
@@ -92,7 +94,8 @@ For more options and detailed explanations, please see the [Puppet AEM Wiki][wik
   - [Define: aem::package](#define-aempackage)
   - [Define: aem::config](#define-aemconfig)
 - **[Private Types][]**
-  - [Type: aem::Aem_Installer](#type-aemaem_installer)
+  - [Type: Aem_Installer](#type-aem_installer)
+  - [Type: Aem_Osgi_Config](#type-aem_osgi_config)
 
 ### Public Defines
 
@@ -116,10 +119,10 @@ See [Beginning with AEM][] for the minimum configuration required to create an A
 Namevar. Required. Specifies the name of the AEM instance.
 
 ##### `ensure`
-Optional. Changes the state of the AEM instance. Valid values are `present` or `absent`. Default: `present`.
+Optional. Changes the state of the AEM instance. Valid options: `present` or `absent`. Default: `present`.
 
 ##### `context_root`
-Optional. Specifies the URL context root for the AEM application. [Sling documentation][Sling launchpad]. Defaults to `/`.
+Optional. Specifies the URL context root for the AEM application. [Sling documentation][Sling launchpad]. Valid options: any valid URI path. Defaults to `/`.
 
 ##### `debug_port`
 Optional. Specifies the port on which to listen for remote debugging connections. Setting this will add the following JVM options: `-Xdebug -Xnoagent -Djava.compiler=NONE -Xrunjdwp:transport=dt_socket,server=y,suspend=n,address=<<port>>` Valid options: any port number.
@@ -145,6 +148,9 @@ Optional. Sets whether or not this instance will manage the defined home directo
 ##### `manage_user`
 Optional. Sets whether or not this instance will manage the defined user. Valid options: `true` or `false`. Default: `true`.
 
+##### `osgi_configs`
+Optional. Creates *file* type definitions of `aem::osgi::config` which will be applied prior to inital AEM start. Valid options: Hash or Array of Hash configurations.
+
 ##### `port`
 Optional. Specifies the port on which AEM will listen. Valid options: any valid port. Default: 4502. [Sling documentation][Sling command-line-options]
 
@@ -177,7 +183,7 @@ Optional. Specifies the AEM installation type. Valid options: `author` or `publi
 Optional. Sets the user for installation. Valid options: any valid user. Default: `aem`.
 
 ##### `version`
-Optional. Sets the version of AEM. Informational only, does not affect installation or resource management. Valid options: any semantic version. 
+Optional. Sets the version of AEM. Informational only, does not affect installation or resource management. Valid options: any semantic version.
 
 #### Define: `aem::license`
 
@@ -189,16 +195,16 @@ Manages an AEM License file. Provides a convenient tool for managing the license
 Namevar. Required. Specifies the name of the AEM license.
 
 ##### `ensure`
-Optional. Changes the state of the AEM license. Valid values are `present` or `absent`. Default: `present`.
+Optional. Changes the state of the AEM license. Valid options: `present` or `absent`. Default: `present`.
 
 ##### `customer`
-Optional. Specifies the customer name for the license file.
+Optional. Specifies the customer name for the license file. Valid options: any string
 
 ##### `group`
 Optional. Sets the group for file ownership. Valid options: any valid group. Default: `aem`.
 
 ##### `home`
-Required. Sets the directory in which the license will be placed. Valid options: Any absolute path.
+Required. Sets the directory in which the license will be placed. Valid options: any absolute path.
 
 ##### `license_key`
 Required. Sets the license key for AEM. Valid options: any string.
@@ -228,7 +234,7 @@ Optional. Sets the group for file ownership. Valid options: any valid group. Def
 Required. Sets the directory in which the AEM instance exists, necessary for service configuration definition. Valid options: Any absolute system path.
 
 ##### `status`
-Optional. Changes the state of the service on the system, defining whether or not the service starts at system boot and/or is currently running. Valid values are:
+Optional. Changes the state of the service on the system, defining whether or not the service starts at system boot and/or is currently running. Valid options:
 * `enabled`: Start at boot & currently running (**Default**)
 * `disabled`: Not started at boot & not currently running.
 * `running`: Not started at boot but is currently running.
@@ -237,6 +243,42 @@ Optional. Changes the state of the service on the system, defining whether or no
 ##### `user`
 Optional. Sets the user for for file ownership. Valid options: any valid user. Default: `aem`.
 
+#### Define: `aem::osgi::config`
+
+Manages an AEM OSGi Configuration; allows for saving Service/Component configurations via a file or posted to the Felix Web Console.
+
+** Parameters within `aem::osgi::config`:**
+
+##### `name`
+Namevar. Required. Specifies the name of the AEM OSGi Configuration. This should be the Service PID. [Apache Felix Documentation][Felix Configuration]
+
+##### `ensure`
+Optional. Changes the state of the AEM OSGi configuration. A value of `absent` will delete the configuration. Valid options: `present` or `absent`. Default: `present`.
+
+##### `group`
+Optional. Sets the group for file ownership. Valid options: any valid group. Default: `aem`.
+
+##### `handle_missing`
+Required if **type** == `console`. Determine how to handle properties which are configured in the console, but not provided. See [wiki][wiki] for examples. Valid options: `merge` or `remove`.
+
+##### `home`
+Required. Sets the directory in which AEM exists. Valid options: Any absolute path.
+
+##### `password`
+Required if **type** == `console`. Sets the password of the OSGI console user. Valid options: any valid password.
+
+##### `properties`
+Required. Sets the configuration properties to persist. Valid options: a hash of values.
+
+##### `type`
+Required. Sets the means by which to persist the configuration. Valid options:  `console` or `file`. `console` will use API calls to the OSGi Web Console. `file` will persist to a properties file in the *crx-quickstart/install* folder.
+
+##### `user`
+Optional. Sets the user for for file ownership. Valid options: any valid user. Default: `aem`.
+
+##### `username`
+Required if **type** == `console`. Sets the user for accessing the OSGI console. Valid options: any valid user.
+
 ### Private Defines
 
 #### Define: `aem::package`
@@ -245,19 +287,25 @@ This define unpacks the AEM Quickstart jar for prepartion to configure.
 #### Define: `aem::config`
 This define sets up the start templates to ensure the AEM instance executes with the correct state.
 
+#### Define: `aem::osgi::config::file`
+This define is used to manage OSGi Configurations which are of type `file`.
+
 ### Private Types
 
-#### Type: `aem::aem_installer`
+#### Type: `aem_installer`
 This custom type starts the AEM instance to create the base repository, monitors for it's initalization, then shuts the system down.
 
+#### Type: `aem_osgi_config`
+This custom type manages OSGi Configurations which are of type `console`.
+
 ## Limitations
 
 ### OS Compatibility
 
 This module has been tested on: 
 
 - CentOS 7, 7.2
-- Ubuntu 12.04, 14.04
+- Ubuntu 12.04*, 14.04
 - Debian 7.8*, 8.2
 
 *See [Known Issues][]*
@@ -269,6 +317,10 @@ This module has been tested with the following AEM versions:
 - 6.0
 - 6.1
 
+### Minimum Ruby Requirement
+
+Using the OSGi Configuration options require a Minimum ruby version of 1.9.x.
+
 ### Warnings
 
 It is up to the consumer to ensure that the correct version of Java is installed based on the AEM version. See [AEM Documentation][AEM Java Requirements] for compatibility.
@@ -277,6 +329,8 @@ Defining an AEM resource as absent will remove the instance from the system, reg
 
 ### Known Issues
 
+Ubuntu 12.04 ships with Ruby 1.8.x; therefore the OSGi configurations acceptance tests fail.
+
 There is an oddity with the `aem::service` support on Debian: even though specifying a valid status sends the correct parameters to the underlying service resource, the service is not enabled, nor do state changes occur correctly. Acceptance tests on those Virtual Machines fail for issues with service management. See [issue #36](https://github.com/bstopp/puppet-aem/issues/36).
 
 ## Development

Rakefile

@@ -11,8 +11,9 @@ task :default => [:spec, :lint, :rubocop]
 PuppetLint.configuration.fail_on_warnings = true
 PuppetLint.configuration.send('relative')
 PuppetLint.configuration.send('disable_80chars')
-PuppetLint.configuration.send('disable_documentation')
-PuppetLint.configuration.send('disable_single_quote_string_with_variables')
+#PuppetLint.configuration.send('disable_documentation')
+PuppetLint.configuration.send('disable_variable_scope')
+#PuppetLint.configuration.send('disable_single_quote_string_with_variables')
 
 PuppetLint.configuration.ignore_paths = exclude_paths
 PuppetSyntax.exclude_paths = exclude_paths