jujube 0.5.0

data/lib/jujube/job_file_generator.rb

@@ -0,0 +1,17 @@
+module Jujube
+  # Generate a YAML file suitable for jenkins-job-builder.
+  class JobFileGenerator
+
+    # Generate a jenkins-job-builder YAML file for a list of jobs.
+    #
+    # @param jobs [Array] The job definitions to include in the output.
+    # @param output [Pathname] The output file to generate.  Any intermediate
+    #   directories are created automatically.
+    def generate(jobs, output)
+      output.dirname.mkpath
+      output.open("w") do |io|
+        jobs.map(&:to_h).to_yaml(io)
+      end
+    end
+  end
+end

data/lib/jujube/job_loader.rb

@@ -0,0 +1,51 @@
+module Jujube
+
+  # Loads job definitions from a set of files and/or directories.
+  class JobLoader
+
+    # Load job definitions from one or more files and/or directories.
+    #
+    # The job definition files are loaded as Ruby files; it is expected that
+    # will make use of the {#job} DSL function, but they can contain other
+    # Ruby code as well.
+    #
+    # @param pathnames [Pathname...] The file or directory names containing
+    # the job definitions.
+    def load_jobs(*pathnames)
+      Job.all_defined_during do
+        pathnames.each do |path|
+          load_one(path)
+        end
+      end
+    end
+
+    private
+
+    # Load jobs from a single file or directory
+    #
+    # @param path [Pathname] The file or directory to load from.
+    def load_one(path)
+      if path.directory?
+        load_directory(path)
+      else
+        load_file(path)
+      end
+    end
+
+    # Load jobs from all (recursive) files in a directory.
+    #
+    # @param path [Pathname] The directory to search.
+    def load_directory(path)
+      path.each_child do |child|
+        load_one(child)
+      end
+    end
+
+    # Load jobs from a single file.
+    #
+    # @param path [Pathname] The file to load.
+    def load_file(path)
+      load(path)
+    end
+  end
+end

data/lib/jujube/macros.rb

@@ -0,0 +1,35 @@
+module Jujube
+
+  # Macros for defining methods that make it easier to specify the parts
+  # a job.
+  module Macros
+    include Jujube::Utils
+
+    # A macro that defines an attribute of a job.
+    # It generates a reader and a writer for the attribute.
+    #
+    # @param attribute_name [Symbol] The name of the attribute.
+    def attribute(attribute_name)
+      canonical_name = canonicalize(attribute_name)
+
+      define_method attribute_name do
+        config[canonical_name]
+      end
+
+      define_method "#{attribute_name}=".to_sym do |value|
+        config[canonical_name] = value
+      end
+    end
+
+    # A macro that defines a section of a job.
+    # It generates a method that returns the `Array` of components
+    # in that section.
+    #
+    # @param section_name [Symbol] The name of the section.
+    def section(section_name)
+      define_method section_name do
+        config[section_name.to_s] ||= []
+      end
+    end
+  end
+end

data/lib/jujube/utils.rb

@@ -0,0 +1,27 @@
+module Jujube
+  # Private utility methods.
+  module Utils
+    private
+
+    # Convert a hash key into the canonical format required by
+    # jenkins-job-builder.  Keys must be strings and use
+    # dashes (`-`) instead of underscores (`_`).
+    #
+    # @param key [Symbol] The key to canonicalize.
+    # @return [String] The key in canonical format.
+    def canonicalize(key)
+      key.to_s.gsub("_", "-")
+    end
+
+    # Ensure that all of the keys in an options hash are in
+    # canonical jenkins-job-builder format.  This method only
+    # looks at the top-level keys; it assumes that any
+    # nested hashes have already been {#canonicalize}d.
+    #
+    # @param options [Hash] The options to canonicalize.
+    # @return [Hash] The options in canonical format.
+    def canonicalize_options(options)
+      Hash[options.map { |k, v| [canonicalize(k), v] }]
+    end
+  end
+end

data/lib/jujube/version.rb

@@ -0,0 +1,5 @@
+# The main namespace for the Jujube gem.
+module Jujube
+  # The current version of the Jujube gem.
+  VERSION = "0.5.0"
+end

data/test/components/builders_test.rb

@@ -0,0 +1,10 @@
+require_relative "../test_helper"
+
+class BuildersTest < Minitest::Test
+  include Jujube::Components
+
+  def test_shell
+    expected = {'shell' => 'COMMAND'}
+    assert_equal(expected, shell('COMMAND'))
+  end
+end

data/test/components/parameters_test.rb

@@ -0,0 +1,15 @@
+require_relative "../test_helper"
+
+class ParametersTest < Minitest::Test
+  include Jujube::Components
+
+  def test_label_expression_axis
+    expected = {"axis" => {"type" => "label-expression", "name" => "arch", "values" => %w{i386 amd64}}}
+    assert_equal(expected, label_expression(:arch, %w{i386 amd64}))
+  end
+
+  def test_slave_axis
+    expected = {"axis" => {"type" => "slave", "name" => "arch", "values" => %w{i386 amd64}}}
+    assert_equal(expected, slave(:arch, %w{i386 amd64}))
+  end
+end

data/test/components/publishers_test.rb

@@ -0,0 +1,51 @@
+require_relative "../test_helper"
+
+class PublishersTest < Minitest::Test
+  include Jujube::Components
+
+  def test_email_ext
+    assert_equal("email-ext", email_ext)
+  end
+
+  def test_email_ext_with_recipients
+    expected = {"email-ext" => {"recipients" => "fred, barney"}}
+    assert_equal(expected, email_ext(recipients: %w{fred barney}.join(", ")))
+  end
+
+  def test_ircbot
+    expected = {"ircbot" => {"notify-start" => true}}
+    assert_equal(expected, ircbot(notify_start: true))
+  end
+
+  def test_junit
+    expected = {"junit" => {"results" => "RESULTS", "keep-long-stdio" => false}}
+    assert_equal(expected, junit(results: "RESULTS", keep_long_stdio: false))
+  end
+
+  def test_archive
+    expected = {"archive" => {"artifacts" => "ARTIFACTS", "latest-only" => true, "allow-empty" => true}}
+    assert_equal(expected, archive(artifacts: "ARTIFACTS", latest_only: true, allow_empty: true))
+  end
+
+  def test_cppcheck
+    expected = {"cppcheck" => {"pattern" => "PATTERN"}}
+    assert_equal(expected, cppcheck(pattern: "PATTERN"))
+  end
+
+  def test_xunit
+    expected = {"xunit" =>
+                    {"types" =>
+                         [{"unittest" => {"pattern" => "PATTERN", "deleteoutput" => false}}]
+                    }
+    }
+    actual = xunit do |types|
+      types << unittest(pattern: "PATTERN", deleteoutput: false)
+    end
+    assert_equal(expected, actual)
+  end
+
+  def test_trigger
+    expected = {"trigger" => {"project" => "PROJECT"}}
+    assert_equal(expected, trigger(project: "PROJECT"))
+  end
+end

data/test/components/scm_test.rb

@@ -0,0 +1,11 @@
+require_relative "../test_helper"
+
+class ScmTest < Minitest::Test
+  include Jujube::Components
+
+  def test_git
+    expected = {"git" => {"url" => "URL", "branches" => ["master", "dev"], "wipe-workspace" => false}}
+    actual = git(url: "URL", branches: %w{master dev}, wipe_workspace: false)
+    assert_equal(expected, actual)
+  end
+end

data/test/components/triggers_test.rb

@@ -0,0 +1,81 @@
+require_relative "../test_helper"
+
+class TriggersTest < Minitest::Test
+  include Jujube::Components
+
+  def test_pollscm
+    assert_equal({"pollscm" => "INTERVAL"}, pollscm("INTERVAL"))
+  end
+
+  def test_pollurl_with_no_content_checks
+    expected = {"pollurl" =>
+                    {"cron" => "CRON",
+                     "urls" => [{"url" => "URL", "check-date" => true}]
+                    }
+    }
+    actual = pollurl(cron: "CRON") do |urls|
+      urls << url("URL", check_date: true)
+    end
+    assert_equal(expected, actual)
+  end
+
+  def test_pollurl_with_simple_content
+    expected = {"pollurl" =>
+                    {"urls" =>
+                         [{"url" => "URL",
+                           "check-content" => [{"simple" => true}]}]
+                    }
+    }
+    actual = pollurl do |urls|
+      urls << url("URL") do |content|
+        content << simple
+      end
+    end
+    assert_equal(expected, actual)
+  end
+
+  def test_pollurl_with_json_content
+    expected = {"pollurl" =>
+                    {"urls" =>
+                         [{"url" => "URL",
+                           "check-content" => [{"json" => %w{JSON_PATH1 JSON_PATH2}}]}]
+                    }
+    }
+    actual = pollurl do |urls|
+      urls << url("URL") do |content|
+        content << json("JSON_PATH1", "JSON_PATH2")
+      end
+    end
+    assert_equal(expected, actual)
+  end
+
+  def test_pollurl_with_xml_content
+    expected = {"pollurl" =>
+                    {"urls" =>
+                         [{"url" => "URL",
+                           "check-content" => [{"xml" => %w{XPATH1 XPATH2}}]}]
+                    }
+    }
+    actual = pollurl do |urls|
+      urls << url("URL") do |content|
+        content << xml("XPATH1", "XPATH2")
+      end
+    end
+    assert_equal(expected, actual)
+  end
+
+  def test_pollurl_with_text_content
+    expected = {"pollurl" =>
+                    {"urls" =>
+                         [{"url" => "URL",
+                           "check-content" => [{"text" => %w{REGEX1 REGEX2}}]}]
+                    }
+    }
+    actual = pollurl do |urls|
+      urls << url("URL") do |content|
+        content << text("REGEX1", "REGEX2")
+      end
+    end
+    assert_equal(expected, actual)
+  end
+end

data/test/components/wrappers_test.rb

@@ -0,0 +1,19 @@
+require_relative "../test_helper"
+
+class WrappersTest < Minitest::Test
+  include Jujube::Components
+
+  def test_timestamps
+    assert_equal('timestamps', timestamps)
+  end
+
+  def test_timeout
+    expected = {'timeout' => {'type' => 'elastic', 'fail' => true}}
+    assert_equal(expected, timeout(type: 'elastic', fail: true))
+  end
+
+  def test_canonicalizes_timeout_keys
+    expected = {'timeout' => {'elastic-percentage' => 150, 'elastic-default-timeout' => 3}}
+    assert_equal(expected, timeout(elastic_percentage: 150, elastic_default_timeout: 3))
+  end
+end

data/test/driver_test.rb

@@ -0,0 +1,47 @@
+require_relative "test_helper"
+require "flexmock"
+
+class DriverTest < Minitest::Test
+  include FlexMock::TestCase
+
+  def setup
+    @jobs = [Object.new, Object.new]
+    @loader = flexmock("loader", :on, Jujube::JobLoader)
+    @generator = flexmock("generator", :on, Jujube::JobFileGenerator)
+    @driver = Jujube::Driver.new(@loader, @generator)
+  end
+
+  def test_loads_all_files_in_current_directory_by_default
+    @driver.run([])
+    assert_spy_called(@loader, :load_jobs, Pathname.getwd)
+  end
+
+  def test_loads_single_file
+    @driver.run(%w{test.job})
+    assert_spy_called(@loader, :load_jobs, Pathname.new("test.job"))
+  end
+
+  def test_loads_multiple_files
+    @driver.run(%w{job1.job job2.job})
+    assert_spy_called(@loader, :load_jobs, Pathname.new("job1.job"), Pathname.new("job2.job"))
+  end
+
+  def test_generates_job_files
+    @loader.should_receive(:load_jobs => @jobs)
+    @driver.run([])
+    assert_spy_called(@generator, :generate, @jobs, Pathname.new("jobs.yml"))
+  end
+
+  def test_generates_into_output_file
+    @loader.should_receive(:load_jobs => @jobs)
+    @driver.run(%w{-o OUTPUT_FILE})
+    assert_spy_called(@generator, :generate, @jobs, Pathname.new("OUTPUT_FILE"))
+  end
+
+  def test_handles_mix_of_arguments
+    @loader.should_receive(:load_jobs => @jobs)
+    @driver.run(%w{job1.job job2.job -o OUTPUT_FILE})
+    assert_spy_called(@loader, :load_jobs, Pathname.new("job1.job"), Pathname.new("job2.job"))
+    assert_spy_called(@generator, :generate, @jobs, Pathname.new("OUTPUT_FILE"))
+  end
+end

data/test/job_test.rb

@@ -0,0 +1,79 @@
+require_relative "test_helper"
+
+class JobTest < Minitest::Test
+  include Jujube
+
+  def setup
+    @job = Job.new("testJob")
+  end
+
+  def test_knows_name
+    assert_equal("testJob", @job.name)
+  end
+
+  def test_includes_name
+    assert_yaml_matches("name: testJob")
+  end
+
+  def test_includes_description
+    @job.description = "DESCRIPTION"
+    assert_yaml_matches("description: DESCRIPTION")
+  end
+
+  def test_includes_node
+    @job.node = "NODE"
+    assert_yaml_matches("node: NODE")
+  end
+
+  def test_includes_block_upstream
+    @job.block_upstream = true
+    assert_yaml_matches("block-upstream: true")
+  end
+
+  def test_includes_block_downstream
+    @job.block_downstream = true
+    assert_yaml_matches("block-downstream: true")
+  end
+
+  def test_includes_quiet_period
+    @job.quiet_period = 42
+    assert_yaml_matches("quiet-period: 42")
+  end
+
+  def test_includes_single_item_section
+    @job.triggers << "TRIGGER"
+    assert_yaml_matches("triggers:\s*\n  - TRIGGER")
+  end
+
+  def test_includes_multi_item_section
+    @job.wrappers << "FIRST" << "SECOND"
+    assert_yaml_matches("wrappers:\s*\n  - FIRST\n  - SECOND")
+  end
+
+  def test_infers_matrix_project_type_when_axes_specified
+    @job.axes << "AXIS"
+    assert_yaml_matches("project-type: matrix")
+  end
+
+  def test_renames_scms_to_scm
+    @job.scm << "SCM"
+    assert_yaml_matches("scm:\s*\n  - SCM")
+  end
+
+  def test_self_registers_with_active_registry
+    job1 = nil
+    job2 = nil
+    jobs = Job.all_defined_during do
+      job1 = Job.new("job1")
+      job2 = Job.new("job2")
+    end
+    assert_equal([job1, job2], jobs)
+  end
+
+  private
+
+  def assert_yaml_matches(snippet)
+    expected = %r{^job:\s*$.*^  #{snippet}$}m
+    assert_match(expected, @job.to_yaml)
+  end
+end