jujube 0.5.0

data/acceptance/jujube/end_to_end_test.rb

@@ -0,0 +1,13 @@
+require_relative "acceptance_test.rb"
+require "minitest/autorun"
+require "yaml"
+
+class EndToEndTest < AcceptanceTest
+  def test_end_to_end
+    with_fixture("endToEnd") do
+      run_jujube("endToEnd.job")
+      assert_exits_cleanly
+      assert_equal(YAML.load_file("expected.yml"), YAML.load_file("jobs.yml"))
+    end
+  end
+end

data/acceptance/jujube/usage_test.rb

@@ -0,0 +1,90 @@
+require_relative "acceptance_test.rb"
+require "minitest/autorun"
+
+class UsageTest < AcceptanceTest
+
+  def test_generates_single_job
+    with_fixture("singleJob") do
+      run_jujube("test.job")
+      assert_exits_cleanly
+      assert_file_exists("jobs.yml")
+      assert_job_created("example")
+      assert_match(/^\s*description: DESCRIPTION\s*$/m, File.read("jobs.yml"))
+    end
+  end
+
+  def test_generates_multiple_jobs_from_single_file
+    with_fixture("multipleJobs") do
+      run_jujube("test.job")
+      assert_exits_cleanly
+      assert_file_exists("jobs.yml")
+      assert_job_created("job1")
+      assert_job_created("job2")
+    end
+  end
+
+  def test_generates_jobs_from_multiple_files
+    with_fixture("multipleFiles") do
+      run_jujube("job1.job", "job2.job")
+      assert_exits_cleanly
+      assert_file_exists("jobs.yml")
+      assert_job_created("job1")
+      assert_job_created("job2")
+    end
+  end
+
+  def test_generates_jobs_from_all_files_in_current_directory_by_default
+    with_fixture("multipleFiles") do
+      run_jujube
+      assert_exits_cleanly
+      assert_file_exists("jobs.yml")
+      assert_job_created("job1")
+      assert_job_created("job2")
+    end
+  end
+
+  def test_generates_jobs_from_all_files_in_directory
+    with_fixture("multipleFiles") do
+      run_jujube(".")
+      assert_exits_cleanly
+      assert_file_exists("jobs.yml")
+      assert_job_created("job1")
+      assert_job_created("job2")
+    end
+  end
+
+  def test_generates_jobs_from_all_recursive_files_in_directory
+    with_fixture("multipleFiles") do
+      run_jujube(".")
+      assert_exits_cleanly
+      assert_file_exists("jobs.yml")
+      assert_job_created("job1")
+      assert_job_created("job2")
+    end
+  end
+
+  def test_places_output_in_current_directory_by_default
+    with_fixture("multipleFiles") do
+      run_jujube(".")
+      assert_exits_cleanly
+      assert_file_exists("jobs.yml")
+      assert_job_created("job1")
+      assert_job_created("job2")
+    end
+  end
+
+  def test_places_output_in_specified_output_file
+    with_fixture("singleJob") do
+      run_jujube("test.job", "-o", "output/my_jobs.yml")
+      assert_exits_cleanly
+      assert_directory_exists("output")
+      assert_file_exists("output/my_jobs.yml")
+    end
+  end
+
+  private
+
+  def assert_job_created(job, output_file = "jobs.yml")
+    assert_match(/^- job:\s*\n    name: #{job}$/m, File.read(output_file))
+  end
+end

data/bin/jujube

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'jujube'
+
+Jujube::Driver.run

data/jujube.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jujube/version'
+
+Gem::Specification.new do |spec|
+  spec.name = "jujube"
+  spec.version = Jujube::VERSION
+  spec.authors = ["Randy Coulman"]
+  spec.email = ["rcoulman@gmail.com"]
+  spec.description = <<EOF
+Jujube provides a Ruby front-end for specifying Jenkins jobs.  It generates YAML files that
+are then used as input for jenkins-job-builder.
+EOF
+  spec.summary = %q{Ruby front-end for jenkins-job-builder}
+  spec.homepage = "https://github.com/randycoulman/jujube"
+  spec.license = "MIT"
+
+  spec.files = `git ls-files`.split($/)
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files = spec.files.grep(%r{^(test|spec|features|acceptance)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake", "~> 10.1"
+  spec.add_development_dependency "minitest", "~> 5.3"
+  spec.add_development_dependency "flexmock", "~> 1.3"
+  spec.add_development_dependency "yard", "~>0.8.7"
+end

data/lib/jujube.rb

@@ -0,0 +1,6 @@
+require "jujube/version"
+require "jujube/driver"
+require "jujube/utils"
+require "jujube/components"
+require "jujube/job"
+require "jujube/dsl"

data/lib/jujube/components.rb

@@ -0,0 +1,23 @@
+require_relative "components/macros"
+require_relative "components/helpers"
+require_relative "components/parameters"
+require_relative "components/scm"
+require_relative "components/triggers"
+require_relative "components/wrappers"
+require_relative "components/builders"
+require_relative "components/publishers"
+require_relative "components/notifications"
+
+module Jujube
+  # Helper methods for creating jenkins-job-builder components.
+  module Components
+    include Helpers
+    include Parameters
+    include Scm
+    include Triggers
+    include Wrappers
+    include Builders
+    include Publishers
+    include Notifications
+  end
+end

data/lib/jujube/components/builders.rb

@@ -0,0 +1,19 @@
+module Jujube
+  module Components
+
+    # Helper methods for creating builder components.
+    module Builders
+
+      # Specify a `shell` builder for a job.
+      #
+      # See {http://ci.openstack.org/jenkins-job-builder/builders.html#builders.shell}.
+      #
+      # @param command [String] The shell command to execute.
+      # @return [Hash] The specification for the component.
+      def shell(command)
+        {'shell' => command}
+      end
+
+    end
+  end
+end

data/lib/jujube/components/helpers.rb

@@ -0,0 +1,40 @@
+module Jujube
+  module Components
+
+    # Helper methods for working with options hashes.
+    module Helpers
+      include Jujube::Utils
+
+      private
+
+      # Build a named array of nested configuration options by yielding to a client-supplied
+      # block.
+      #
+      # @param name [Symbol] The name of the nested configuration options.
+      # @param options [Hash] Additional top-level configuration options.
+      # @return [Hash] A named configuration that includes the top-level options and all
+      #   nested options provided by the client's block.
+      # @yieldparam nested [Array] The array of nested options to be built up by the
+      #   client-provided block.
+      def nested_options(name, options = {})
+        nested = []
+        yield(nested) if block_given?
+        options.merge!(name => nested) unless nested.empty?
+        options
+      end
+
+      # Convert a name and a set of named options into the canonical `Hash` format
+      # required by jenkins-job-builder.
+      #
+      # @param key [Symbol] The name for the options.
+      # @param options [Hash] The named options.
+      # @return [Hash, String] The resulting canonical `Hash`.  If no options are
+      #   provided, then just the `canonicalize`d name will be returned.
+      def to_config(key, options)
+        return key if options.empty?
+
+        {key => canonicalize_options(options)}
+      end
+    end
+  end
+end

data/lib/jujube/components/macros.rb

@@ -0,0 +1,31 @@
+module Jujube
+  module Components
+
+    # Macros for defining components and their nested configuration elements
+    module Macros
+      include Jujube::Utils
+
+      private
+
+      # A macro that defines a standard component.  A standard
+      # component has a name and a `Hash` of named options.  The name and all option
+      # keys are {#canonicalize}d.
+      #
+      # @param name [Symbol] The name of the component to generate.
+      def standard_component(name)
+        named_config(name)
+      end
+
+      # A macro that defines methods that generate a standard named
+      # configuration.  A standard named configuration has a name and a `Hash`
+      # of named options.  The names and all option keys are {#canonicalize}d.
+      #
+      # @param name [Symbol] The name of the method to generate.
+      def named_config(name)
+        define_method(name) do |options = {}|
+          to_config(canonicalize(name), options)
+        end
+      end
+    end
+  end
+end

data/lib/jujube/components/notifications.rb

@@ -0,0 +1,11 @@
+module Jujube
+  module Components
+
+    # Helper methods for creating notification components.
+    module Notifications
+
+      # None defined yet
+
+    end
+  end
+end

data/lib/jujube/components/parameters.rb

@@ -0,0 +1,50 @@
+module Jujube
+  module Components
+
+    # Helper methods for creating job parameter components.
+    module Parameters
+
+      # @!group Matrix Axes
+
+      # Specify a `label-expression` axis for a matrix job.
+      #
+      # See {http://ci.openstack.org/jenkins-job-builder/project_matrix.html}.
+      #
+      # @param name [Symbol, String] The name of the axis.
+      # @param values [Array<String>] The values of the axis.
+      # @return [Hash] The specification for the axis.
+      def label_expression(name, values)
+        axis(name, values, :label_expression)
+      end
+
+      # Specify a `slave` axis for a matrix job.
+      #
+      # See {http://ci.openstack.org/jenkins-job-builder/project_matrix.html}.
+      #
+      # @param name [Symbol, String] The name of the axis.
+      # @param values [Array<String>] The values of the axis.
+      # @return [Hash] The specification for the axis.
+      def slave(name, values)
+        axis(name, values, :slave)
+      end
+
+      private
+
+      # Specify an axis for a matrix job.
+      #
+      # See {http://ci.openstack.org/jenkins-job-builder/project_matrix.html}.
+      #
+      # @param name [Symbol, String] The name of the axis.
+      # @param values [Array<String>] The values of the axis.
+      # @param type [Symbol, String] The axis type.
+      # @return [Hash] The specification for the axis.
+      def axis(name, values, type)
+        options = {type: canonicalize(type), name: canonicalize(name), values: values}
+        to_config("axis", options)
+      end
+
+      # @!endgroup
+
+    end
+  end
+end

data/lib/jujube/components/publishers.rb

@@ -0,0 +1,97 @@
+module Jujube
+  module Components
+
+    # Helper methods for creating publisher components.
+    module Publishers
+      extend Macros
+
+      # @!method archive(options = {})
+      # Specify an `archive` component for a job.
+      #
+      # See {http://ci.openstack.org/jenkins-job-builder/publishers.html#publishers.archive}.
+      #
+      # @param options [Hash] The configuration options for the component.
+      # @return [Hash] The specification for the component.
+      standard_component :archive
+
+      # @!method cppcheck(options = {})
+      # Specify a `cppcheck` component for a job.
+      #
+      # See {http://ci.openstack.org/jenkins-job-builder/publishers.html#publishers.cppcheck}.
+      #
+      # @param options [Hash] The configuration options for the component.
+      # @return [Hash] The specification for the component.
+      standard_component :cppcheck
+
+      # @!method email_ext(options = {})
+      # Specify an `email-ext` component for a job.
+      #
+      # See {http://ci.openstack.org/jenkins-job-builder/publishers.html#publishers.email-ext}.
+      #
+      # @param options [Hash] The configuration options for the component.
+      # @return [Hash] The specification for the component.
+      standard_component :email_ext
+
+      # @!method ircbot(options = {})
+      # Specify an `ircbot` component for a job.
+      #
+      # See {http://ci.openstack.org/jenkins-job-builder/publishers.html#publishers.ircbot}.
+      #
+      # @param options [Hash] The configuration options for the component.
+      # @return [Hash] The specification for the component.
+      standard_component :ircbot
+
+      # @!method junit(options = {})
+      # Specify a `junit` component for a job.
+      #
+      # See {http://ci.openstack.org/jenkins-job-builder/publishers.html#publishers.junit}.
+      #
+      # @param options [Hash] The configuration options for the component.
+      # @return [Hash] The specification for the component.
+      standard_component :junit
+
+      # @!method trigger(options = {})
+      # Specify a `trigger` component for a job.
+      #
+      # See {http://ci.openstack.org/jenkins-job-builder/publishers.html#publishers.trigger}.
+      #
+      # @param options [Hash] The configuration options for the component.
+      # @return [Hash] The specification for the component.
+      standard_component :trigger
+
+      # Specify an `xunit` component for a job.
+      #
+      # See {http://ci.openstack.org/jenkins-job-builder/publishers.html#publishers.xunit}.
+      #
+      # `xunit` can publish multiple sets of test results.  The specification for each set
+      # of test results is added in a nested configuration block using the {#unittest} method.
+      #
+      # @example
+      #    job "xunit-example" do |j|
+      #      j.publishers << xunit do |types|
+      #        types << unittest(pattern: "PATTERN", deleteoutput: false)
+      #      end
+      #    end
+      #
+      # @param options [Hash] Top-level options for configuring the component.
+      # @yieldparam types [Array] An array to which nested test type specifications should be
+      #   added by the block.
+      # @return [Hash] The specification for the component.
+      def xunit(options = {}, &block)
+        to_config("xunit", nested_options(:types, options, &block))
+      end
+
+      # @!group xunit Test Types
+
+      # @!method unittest(options = {})
+      # Configure a `unittest` test type for an {#xunit} component.
+      #
+      # See {http://ci.openstack.org/jenkins-job-builder/publishers.html#publishers.xunit}.
+      #
+      # @param options [Hash] The configuration options for the test type.
+      # @return [Hash] The specification for the test type.
+      named_config :unittest
+
+    end
+  end
+end

data/lib/jujube/components/scm.rb

@@ -0,0 +1,19 @@
+module Jujube
+  module Components
+
+    # Helper methods for creating SCM components.
+    module Scm
+      extend Macros
+
+      # @!method git(options = {})
+      # Specify a `git` component for a job.
+      #
+      # See {http://ci.openstack.org/jenkins-job-builder/publishers.html#scm.git}.
+      #
+      # @param options [Hash] The configuration options for the component.
+      # @return [Hash] The specification for the component.
+      standard_component :git
+
+    end
+  end
+end