jujube 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 80df34de2a96d739460c44eaa0eda01f6f6e7ea5
+  data.tar.gz: 4d8b6e80aa1ad6a483465f11ae554a9ec1552352
+SHA512:
+  metadata.gz: 52a68f97e65f9ed50feef8e13ccd5a57831f62198da01b4c4f210ba7b15c25347b6488d0a5e97a75e31ed35ba2a1b6fbb1eeb17e767e9c002bbb6fd3428d947b
+  data.tar.gz: 6c5a4a2ae6f04d5c85e0ac3af8f84f83c18229698c51543a36da925a7a4e98db1826c09f758468ecec8c03e210626e1a3cfca8f79096d27145810ec5f8ce11fd

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
+.idea/

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - jruby-19mode
+  - rbx
+script: "bundle exec rake"

data/.yardopts

@@ -0,0 +1,4 @@
+--markup markdown
+-
+README.md
+LICENSE

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jujube.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Randy Coulman
+
+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,180 @@
+# Jujube
+
+[![Build Status](https://travis-ci.org/randycoulman/jujube.svg?branch=master)](https://travis-ci.org/randycoulman/jujube)
+[![Code Climate](https://codeclimate.com/github/randycoulman/jujube.png)](https://codeclimate.com/github/randycoulman/jujube)
+
+**Jujube** is a Ruby front-end for
+[jenkins-job-builder](https://github.com/openstack-infra/jenkins-job-builder).
+
+jenkins-job-builder allows you to specify Jenkins jobs in YAML and then creates or
+updates the jobs in a running Jenkins instance.  It provides some tools for removing
+duplication from job definitions, but sometimes more abstraction capability is needed.
+**Jujube** provides that capability.
+
+Using **Jujube**, you can specify Jenkins jobs using a Ruby DSL (domain-specific language).
+**Jujube** then generates the YAML input needed by jenkins-job-builder.  **Jujube** also makes
+it easy to define methods that act as job templates or pre-configured components.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'jujube'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jujube
+
+## Usage Instructions
+
+### Running Jujube
+
+To run **Jujube** and convert one or more job definitions to YAML for use by jenkins-job-builder:
+
+```
+jujube [--output output-file] file-or-directory*
+```
+
+**Jujube** will load all of the specified files (or all of the files in the specified directories)
+and generate a single YAML file containing all of the jenkins-job-builder job definitions.
+
+If the `--output` (or `-o` for short) option is provided, the job definitions will be generated into
+the specified file.  Any intermediate directories that do not already exist will be created
+automatically.
+
+If no output filename is specified, then a file named `jobs.yml` in the current working directory
+will be used.
+
+### Defining Jobs
+
+To define a Jenkins job using **Jujube**, use the `job` DSL function.  The most basic job definition
+is just a job name:
+
+```ruby
+job "my-job"
+```
+
+Such a job does absolutely nothing, so you will most likely want to provide a configuration block as
+well:
+
+```ruby
+job "my-job" do |j|
+  # Job configuration goes here...
+end
+```
+
+In the job configuration block, you can specify attributes for the job and add components to sections.
+For example:
+
+```ruby
+job "my-job" do |j|
+  j.description = "This is my job."  # Specify attributes
+  j.quiet_period = 5
+
+  j.axes << slave(:arch, %w{i386 amd64}) # Add components to sections
+
+  j.scm << git(url: "https://example.com/git/my-project", branches: %w{master dev})
+
+  j.triggers << pollscm("@hourly")
+
+  j.wrappers << timeout(type: 'elastic', elastic_percentage: 150, elastic_default_timeout: 5, fail: true)
+  j.wrappers << timestamps
+
+  j.builders << shell("bundle && bundle exec rake deploy")
+
+  j.publishers << email_ext(recipients: %w{me@example.com you@example.com})
+end
+```
+
+The following job attributes are supported:
+
+* `description`
+* `project_type` -- doesn't normally need to be specified.  If any `axes` are added to the
+  job, then `project_type` is automatically inferred to be `matrix`
+* `description`
+* `node`
+* `block_upstream`
+* `block_downstream`
+* `quiet_period`
+
+The following sections and components are supported:
+
+* `axes`: (`label_expression`, `slave`)
+* `scm`: (`git`)
+* `triggers`: (`pollscm`)
+* `wrappers`: (`timeout`, `timestamps`)
+* `builders`: (`shell`)
+* `publishers`: (`archive`, `cppcheck`, `email_ext`, `ircbot`, `junit`, `trigger`, `xunit`)
+* `notifications`: None defined yet
+
+See [the end-to-end example job](examples/fixtures/endToEnd/endToEnd.job) for example
+uses of all of the supported attributes, sections, and components.
+
+In general, component options are typically specified as standard Ruby hashes.  The option
+names are the same as in the
+[jenkins-job-builder documentation](http://ci.openstack.org/jenkins-job-builder/),
+except that you need to use underscores (`_`) instead of dashes (`-`) in the option names.
+
+### Helper Methods
+
+In your own projects, you can define helper methods that pre-configure jobs or components.
+Simply `require` the Ruby files containing your helper methods into your job files and use
+them just like the **Jujube** supplied methods.  For example:
+
+```ruby
+def template_job(name, description)
+  job name do |j|
+    j.description = description
+    j.quiet_period = 5
+    j.scm << standard_git(name)
+    j.triggers << pollscm("@hourly")
+    j.wrappers << timestamps
+
+    yield j if block_given?
+  end
+end
+
+def standard_git(repo_name)
+  git(url: "https://example.com/git/#{repo_name}", branches: %w{master dev})
+end
+
+template_job "my-job", "This is my job" do |j|
+  j.builders << shell("rake deploy")
+end
+```
+
+### Things to Note
+
+* **Jujube** doesn't do any input validation.  Rather than duplicating the validation that
+  jenkins-job-builder already does, **Jujube** accepts any component options provided in a job
+  definition and passes them through to the YAML file.  This actually makes **Jujube** quite
+  flexible and able to automatically support new options that are added in jenkins-job-builder.
+
+* **Jujube** does not yet support all of the components that jenkins-job-builder supports.  New
+  components are easy to add, and pull requests are more than welcome.
+
+## Extending Jujube
+
+The `Job` class is the main class in **Jujube**.  It should be essentially complete now.  The
+main work left to be done is to define the remaining components supported by jenkins-job-builder.
+Components are defined in the various files in the `components` sub-directory.  There is one file
+per component type.
+
+Most components can be defined using the `standard_component` "macro".  If the component simply
+takes a hash of options, then it is a standard component.  Otherwise, a specialized method must
+be written for the component.  There are a few examples of these in the codebase.
+
+If you'd like to add a component that requires some odd configuration and you're not sure how to
+tackle it, contact me and I'll be happy to help.
+
+## 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,15 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "yard"
+
+task :default => [:test, :acceptance]
+
+Rake::TestTask.new(:test) do |t|
+  t.pattern = "test/**/*_test.rb"
+end
+
+Rake::TestTask.new(:acceptance) do |t|
+  t.pattern = "acceptance/**/*_test.rb"
+end
+
+YARD::Rake::YardocTask.new

data/acceptance/fixtures/endToEnd/endToEnd.job

@@ -0,0 +1,43 @@
+job "endToEnd" do |j|
+  j.description = "DESCRIPTION"
+  j.node = "NODE"
+  j.block_upstream = true
+  j.block_downstream = false
+  j.quiet_period = 42
+
+  j.axes << slave(:arch, %w{i386 amd64})
+
+  j.scm << git(url: "URL", branches: %w{master dev}, wipe_workspace: false)
+
+  j.triggers << pollscm("INTERVAL")
+  j.triggers << pollurl(cron: "CRON", polling_node: "NODE") do |urls|
+    urls << url("URL",
+                proxy: false,
+                timeout: 442,
+                username: "USERNAME",
+                password: "PASSWORD",
+                check_status: 202,
+                check_etag: false,
+                check_date: true) do |content|
+      content << simple
+      content << json("JSON_PATH1", "JSON_PATH2")
+      content << xml("XPATH1", "XPATH2")
+      content << text("REGEX1", "REGEX2")
+    end
+  end
+
+  j.wrappers << timeout(type: 'elastic', elastic_percentage: 150, elastic_default_timeout: 5, fail: true)
+  j.wrappers << timestamps
+
+  j.builders << shell("COMMAND")
+
+  j.publishers << archive(artifacts: "ARTIFACTS", latest_only: true, allow_empty: true)
+  j.publishers << cppcheck(pattern: "PATTERN")
+  j.publishers << email_ext(recipients: %w{fred barney})
+  j.publishers << ircbot(notify_start: true)
+  j.publishers << junit(results: "RESULTS", keep_long_stdio: false)
+  j.publishers << trigger(project: "PROJECT")
+  j.publishers << xunit do |types|
+    types << unittest(pattern: "PATTERN", deleteoutput: false)
+  end
+end

data/acceptance/fixtures/endToEnd/expected.yml

@@ -0,0 +1,80 @@
+---
+- job:
+    name: endToEnd
+    description: DESCRIPTION
+    node: NODE
+    block-upstream: true
+    block-downstream: false
+    quiet-period: 42
+    project-type: matrix
+    axes:
+      - axis:
+          type: slave
+          name: arch
+          values:
+            - i386
+            - amd64
+    scm:
+      - git:
+          url: URL
+          branches:
+            - master
+            - dev
+          wipe-workspace: false
+    triggers:
+      - pollscm: INTERVAL
+      - pollurl:
+          cron: CRON
+          polling-node: NODE
+          urls:
+            - url: URL
+              proxy: false
+              timeout: 442
+              username: USERNAME
+              password: PASSWORD
+              check-status: 202
+              check-etag: false
+              check-date: true
+              check-content:
+                - simple: true
+                - json:
+                  - JSON_PATH1
+                  - JSON_PATH2
+                - xml:
+                  - XPATH1
+                  - XPATH2
+                - text:
+                  - REGEX1
+                  - REGEX2
+    wrappers:
+      - timeout:
+          type: elastic
+          elastic-percentage: 150
+          elastic-default-timeout: 5
+          fail: true
+      - timestamps
+    builders:
+      - shell: COMMAND
+    publishers:
+      - archive:
+          artifacts: ARTIFACTS
+          latest-only: true
+          allow-empty: true
+      - cppcheck:
+          pattern: PATTERN
+      - email-ext:
+          recipients:
+            - fred
+            - barney
+      - ircbot:
+          notify-start: true
+      - junit:
+          results: RESULTS
+          keep-long-stdio: false
+      - trigger:
+          project: PROJECT
+      - xunit:
+          types:
+            - unittest:
+                pattern: PATTERN
+                deleteoutput: false

data/acceptance/fixtures/multipleFiles/job1.job

@@ -0,0 +1 @@
+job "job1"

data/acceptance/fixtures/multipleFiles/job2.job

@@ -0,0 +1 @@
+job "job2"

data/acceptance/fixtures/multipleJobs/test.job

@@ -0,0 +1,2 @@
+job "job1"
+job "job2"

data/acceptance/fixtures/nestedDirectories/job1.job

@@ -0,0 +1 @@
+job "job1"

data/acceptance/fixtures/nestedDirectories/nested/job2.job

@@ -0,0 +1 @@
+job "job2"

data/acceptance/fixtures/singleJob/test.job

@@ -0,0 +1,3 @@
+job "example" do |j|
+  j.description = "DESCRIPTION"
+end

data/acceptance/jujube/acceptance_test.rb

@@ -0,0 +1,47 @@
+require "minitest/autorun"
+require "open3"
+require "pathname"
+require "tmpdir"
+
+class AcceptanceTest < Minitest::Test
+  def with_fixture(fixture_name)
+    fixture = fixture_root.join(fixture_name)
+    Dir.mktmpdir do |temp_directory|
+      temp_directory = Pathname.new(temp_directory)
+      FileUtils.cp_r(fixture, temp_directory, preserve: true)
+      working = temp_directory.join(fixture_name)
+      Dir.chdir(working) do
+        yield
+      end
+    end
+  end
+
+  def run_jujube(*arguments)
+    jujube = bin_directory.join("jujube").to_s
+    @output, @error_output, @status = Open3.capture3(jujube, *arguments)
+  end
+
+  def assert_exits_cleanly
+    assert_equal(0, @status.exitstatus, @error_output)
+  end
+
+  def assert_file_exists(filename)
+    assert(File.exists?(filename), "File #{filename} does not exist")
+  end
+
+  def assert_directory_exists(filename)
+    assert(Dir.exists?(filename), "Directory #{filename} does not exist")
+  end
+
+  def fixture_root
+    acceptance_root.join("fixtures")
+  end
+
+  def bin_directory
+    acceptance_root.join("..", "bin")
+  end
+
+  def acceptance_root
+    Pathname.new(__FILE__).dirname.join("..").expand_path
+  end
+end