jester 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2fde9b0f05e8ad06038522f9f3224be1960745ca
+  data.tar.gz: 77fcfb3eea73ce17961bc9f8220b30e49a90c0a8
+SHA512:
+  metadata.gz: 1286e5056bbd3aea98c01a42c998d5ffe710239309fa87112de7163857f3b2ffd142cccc188d88a25be73f1edbfa18e6b81f45d7373bcf3e0938f4f6befce7d0
+  data.tar.gz: ecb2aef7079f752437a81f3d763aaaef5792af56c50a379c6e4af52fe9e982132e3e958297a0c9ee0bda4e7db56cf3bc7cd53f31b00a0e70ebec1a8dfa145a6b

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+**/*.log

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.4.2

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.4.1
+  - 2.4.2
+before_install: gem install bundler -v 1.11.2
+script:
+  - rspec

data/Gemfile

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

data/Jenkinsfile

@@ -0,0 +1,12 @@
+#!/usr/bin/env groovy
+
+// this is just a sample Jenkins pipeline script for testing, not for building this project!
+
+node {
+  print "hello world!"
+  print "binding.variables:"
+  binding.variables.each{
+    print it.key
+    print it.value
+  }
+}

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 adampats
+
+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,63 @@
+# Jester
+
+[![Build Status](https://travis-ci.org/adampats/jester.svg?branch=master)](https://travis-ci.org/adampats/jester)
+
+A command line tool to enable more seamless "local" development of Jenkinsfile groovy pipelines without having to do the typical "commit, push, webhook, pipeline job run" to iterate on a pipeline.
+
+Instead, you can use jester, which performs the following:
+
+ * Creates (or uses existing) pipeline job on Jenkins master
+ * Updates the pipeline job's value of the pipeline script with a custom string or local Jenkinsfile
+ * Runs the pipeline job with the newly modified script
+ * Fetches the job console output and saves it to a local file for review
+
+All of this is done from the command line - logging in to the Jenkins UI *not* required.
+
+-----
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jester'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jester
+
+-----
+
+## Usage
+
+If you don't have a Jenkins instance running, you can run one easily in Docker:
+
+```
+docker run -d -p 8080:8080 --name localjenkins jenkins/jenkins:lts
+docker logs localjenkins
+open http://localhost:8080
+# perform basic setup wizard steps to bring the new Jenkins master online
+```
+
+Then you should be able to run jester using the defaults for `-s` / `--url`.
+
+-----
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/adampats/jester.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "jester"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "pry"
+Pry.start

data/bin/jester

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'jester'
+
+Jester::Cli.start(ARGV)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/jester.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jester/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "jester"
+  spec.version       = Jester::VERSION
+  spec.authors       = ["adampats"]
+  spec.email         = ["adampatterson@protonmail.com"]
+
+  spec.summary       = %q{Jenkins pipeline testing iteration tool}
+  spec.description   = %q{jester makes testing Jenkinsfiles much easier.}
+  spec.homepage      = "https://github.com/adampats/jester"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'thor', "~> 0.20.0"
+  spec.add_dependency 'faraday', "~> 0.14.0"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry", "~> 0.11.2"
+end

data/lib/jester/cli.rb

@@ -0,0 +1,219 @@
+require 'thor'
+require 'pry'
+require 'faraday'
+require 'json'
+require 'uri'
+
+module Jester
+  class Cli < Thor
+
+    # Constants
+    JOB_RETRY = 2 # seconds to wait between checking build result
+
+    # Global options
+    class_option :url, desc: "URL of Jenkins master",
+      aliases: '-s', default: "http://localhost:8080"
+    class_option :username, desc: "User to connect with",
+      aliases: '-u', default: "admin"
+    class_option :password, desc: "Password to connect with",
+      aliases: '-p', default: "admin"
+    class_option :verbose, desc: "Toggle verbose/debug output",
+      aliases: '-v', default: false, type: :boolean
+
+    #
+    desc "test", "Test Jenkins server connectivity"
+    def test
+      puts "Testing authenticated connectivity to #{@options[:url]}..."
+      r = get( @options[:url] )
+      version = r['x-jenkins']
+      if version.nil?
+        puts "Fail"
+      else
+        puts "Success!  Running Jenkins version " + version
+      end
+    end
+
+    #
+    desc "new", "Create new Jenkins pipeline job"
+    method_option :job_name, desc: "Pipeline job name",
+      aliases: '-j', default: 'jester-test-job'
+    def new
+      puts "Checking if job, '#{@options[:job_name]}', already exists..."
+      if job_exists?(@options[:job_name])
+        puts "Job already exists!  Quit."
+      else
+        puts "Creating new pipeline job named #{@options[:job_name]}..."
+        job_params = {
+          description: @options[:job_name],
+          script: '// empty job created by jester\n node {print "test"}' }
+        xml = pipeline_xml(job_params)
+        r = post( @options[:url] + "/createItem?name=#{@options[:job_name]}", xml )
+        if r.status == 200
+          puts "Job successfully created."
+        else
+          puts "Job creation failed."
+        end
+      end
+    end
+
+    #
+    desc "build", "Build (run) a Jenkins pipeline job"
+    method_option :job_name, desc: "Pipeline job name",
+      aliases: '-j', default: 'jester-test-job'
+    method_option :pipeline_file, desc: "Path to ad-hoc pipeline (Jenkinsfile) file",
+      aliases: '-f', default: 'Jenkinsfile'
+    def build
+      if File.file?(@options[:pipeline_file])
+        pipeline = File.read(@options[:pipeline_file])
+      else
+        puts "File not found: " + @options[:pipeline_file]
+        raise 'FileNotFound'
+      end
+      job_params = {
+        description: @options[:job_name],
+        script: pipeline }
+      xml = pipeline_xml(job_params)
+
+      if job_exists?(@options[:job_name])
+        path = "/job/" + @options[:job_name] + "/config.xml"
+      else
+        path = "/createItem?name=" + @options[:job_name]
+      end
+      r = post( @options[:url] + path, xml )
+      if r.status != 200
+        puts "Job config update failed."
+        quit
+      else
+        puts "Job config update succeeded."
+      end
+
+      build_path = "/job/" + @options[:job_name] + "/build?delay=0sec"
+      build_resp = post( @options[:url] + build_path )
+      if build_resp.status != 201
+        puts "Unable to run build. Quit"
+        quit
+      else
+        puts "Build running - getting output..."
+      end
+      resp = get(@options[:url] + "/job/" + @options[:job_name] + "/api/json")
+      json = JSON.parse(resp.body)
+      if json['inQueue'] == false
+        build_num = json['lastBuild']['number']
+      end
+
+      build = build_result(@options[:job_name], build_num)
+      puts "Job " + build_num.to_s + " result: " + build['result']
+      log = log_result(@options[:job_name], build_num)
+      puts "DEBUG: " + log.body if debug
+      File.write("#{@options[:job_name]}.log", log.body)
+      puts "See #{@options[:job_name]}.log for output."
+    end
+
+
+    private
+
+    #
+    def debug
+      @options[:verbose]
+    end
+
+    #
+    def get (url, params = {})
+      begin
+        c = Faraday.new(url: url) do |conn|
+          conn.basic_auth(@options[:username], @options[:password])
+          conn.adapter Faraday.default_adapter
+        end
+        resp = c.get
+      rescue Exception => e
+        puts e.message
+        return e
+      end
+    end
+
+    #
+    def post (url, body = nil, params = {})
+      begin
+        crumb = get_crumb(url, @options[:username], @options[:password])
+        puts "DEBUG: crumb = " + crumb if @options[:verbose]
+        c = Faraday.new(url: url) do |conn|
+          conn.basic_auth(@options[:username], @options[:password])
+          conn.adapter Faraday.default_adapter
+        end
+        resp = c.post do |conn|
+          conn.headers['Jenkins-Crumb'] = crumb
+          conn.headers['Content-Type'] = 'application/xml'
+          if body != nil
+            conn.body = body
+          end
+        end
+        if @options[:verbose]
+          puts "DEBUG: "
+          pp resp.to_hash[:response_headers]
+        end
+        return resp
+      rescue Exception => e
+        puts e.message
+        return e
+      end
+    end
+
+    #
+    def get_crumb (url, user, pass)
+      p_url = URI.parse(url)
+      base_url = p_url.scheme + "://" + p_url.host + ":" + p_url.port.to_s
+      r = get(base_url +
+        '/crumbIssuer/api/xml?xpath=concat(//crumbRequestField,":",//crumb)' )
+      r.body.split(':')[1]
+    end
+
+    #
+    # params = { description, script }
+    def pipeline_xml (params = {})
+      return %Q{<?xml version='1.1' encoding='UTF-8'?>
+<flow-definition plugin="workflow-job@2.17">
+  <description>#{params[:description]}</description>
+  <keepDependencies>false</keepDependencies>
+  <properties/>
+  <definition class="org.jenkinsci.plugins.workflow.cps.CpsFlowDefinition" plugin="workflow-cps@2.46">
+    <script>#{params[:script]}</script>
+    <sandbox>true</sandbox>
+  </definition>
+  <triggers/>
+  <disabled>false</disabled>
+</flow-definition>}
+    end
+
+    #
+    def job_exists? (job_name)
+      job = get( @options[:url] + "/job/" + job_name )
+      if job.reason_phrase == "Found"
+        true
+      else
+        false
+      end
+    end
+
+    #
+    def build_result (job_name, build_number)
+      result = nil
+      while result.nil?
+        resp = JSON.parse(
+          get( @options[:url] +
+            "/job/" + job_name + "/" + build_number.to_s + "/api/json").body )
+        if resp['building'] == true || resp['result'].nil?
+          sleep JOB_RETRY
+          print "." if debug
+        end
+        result = resp['result']
+      end
+      resp
+    end
+
+    #
+    def log_result (job_name, build_number)
+      resp = get( @options[:url] + "/job/" + job_name + "/" + build_number.to_s + "/consoleText")
+    end
+
+  end
+end

data/lib/jester/version.rb

@@ -0,0 +1,3 @@
+module Jester
+  VERSION = "0.1.0"
+end

data/lib/jester.rb

@@ -0,0 +1,5 @@
+require "jester/version"
+require "jester/cli"
+
+module Jester
+end

data/temp/config.xml

@@ -0,0 +1,14 @@
+<?xml version='1.1' encoding='UTF-8'?>
+<flow-definition plugin="workflow-job@2.17">
+  <description>test</description>
+  <keepDependencies>false</keepDependencies>
+  <properties/>
+  <definition class="org.jenkinsci.plugins.workflow.cps.CpsFlowDefinition" plugin="workflow-cps@2.46">
+    <script>node {
+    print &quot;hello world&quot;
+}</script>
+    <sandbox>true</sandbox>
+  </definition>
+  <triggers/>
+  <disabled>false</disabled>
+</flow-definition>

data/temp/test_config.xml

@@ -0,0 +1,12 @@
+<?xml version='1.1' encoding='UTF-8'?>
+<flow-definition plugin="workflow-job@2.17">
+  <description>jester-test-job</description>
+  <keepDependencies>false</keepDependencies>
+  <properties/>
+  <definition class="org.jenkinsci.plugins.workflow.cps.CpsFlowDefinition" plugin="workflow-cps@2.46">
+    <script>node { print 'hello world!' }</script>
+    <sandbox>true</sandbox>
+  </definition>
+  <triggers/>
+  <disabled>false</disabled>
+</flow-definition>

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: jester
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- adampats
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-07-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.0
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.2
+description: jester makes testing Jenkinsfiles much easier.
+email:
+- adampatterson@protonmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Jenkinsfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/jester
+- bin/setup
+- jester.gemspec
+- lib/jester.rb
+- lib/jester/cli.rb
+- lib/jester/version.rb
+- temp/config.xml
+- temp/test_config.xml
+homepage: https://github.com/adampats/jester
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Jenkins pipeline testing iteration tool
+test_files: []