fire-jenkins-builder 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 65a70568ce2055b134ab92273530b2a9d89dba37
+  data.tar.gz: 858977371e0632eef1084d67d5f694a00c685f44
+SHA512:
+  metadata.gz: 17c5d97a762b62dc841eb07dedd1d7a78c0f25c51a83726328db48ccb0afa328ad00b84b7050c685f3b8dd273460fbdfe5a336aa6d37dcdd18083ba1c15611f9
+  data.tar.gz: 5d9d382d6c13915ed4d8c9938bca2c2505d47eff0110b6b8cb54351c3789a936282bbc8b954150db7c77fa009eb3cff1b4fb36334daceb0e331f2a5fa4c0b7d7

data/.fire-jenkins.yml

@@ -0,0 +1,37 @@
+# jenkins job 配置文件
+# 可以通过在 commit 中添加 prefix ，使 CI 出发 jenkins job 的创建/构建行为
+# 提交 commit 信息
+# [jenkins create] XXXXXX   创建/更新并执行 jenkins job
+# [jenkins build] XXXXXX 执行 jenkins job
+#
+########################
+#         选填
+########################
+# job 参数
+# 添加自己的钉钉消息等健值对
+# 需要注意的是，这里面的配置，模版必须已经存在了，这里只是修改对应的值
+parameters:
+  REPORTER_ACCESS_TOKEN: XXXXXX
+  DEBUG: true
+
+########################
+#         必填
+########################
+# 打包 job 名称 / 前缀名
+# 如果 job_name 为空，则采用 job_name_prefix + 分支名称
+# job_name: XXXX
+job_name_prefix: ZGiOS_
+# jenkins 上的分组，对应 view
+job_view: 掌柜iOS
+
+# jenkins 用户名密码
+username: qingmu
+password: 1
+
+# 各业务线采用不同的模版，配置这里
+# 模版工程名称（需要唯一）
+template_job_name: ZGiOS_develop
+
+# 这里不动
+server_url: 'http://jenkins-shopkeeper-client.2dfire.net'
+server_port: 80

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at triplec.linux@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in fire-jenkins-builder.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,39 @@
+PATH
+  remote: .
+  specs:
+    fire-jenkins-builder (0.1.0)
+      jenkins_api_client
+      nokogiri
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    jenkins_api_client (1.5.3)
+      json (>= 1.0)
+      mixlib-shellout (>= 1.1.0)
+      nokogiri (~> 1.6)
+      socksify (>= 1.7.0)
+      terminal-table (>= 1.4.0)
+      thor (>= 0.16.0)
+    json (2.1.0)
+    mini_portile2 (2.3.0)
+    mixlib-shellout (2.4.0)
+    nokogiri (1.8.4)
+      mini_portile2 (~> 2.3.0)
+    rake (10.5.0)
+    socksify (1.7.1)
+    terminal-table (1.8.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
+    thor (0.20.0)
+    unicode-display_width (1.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  fire-jenkins-builder!
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 tripleCC
+
+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,113 @@
+# Fire::Jenkins::Builder
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/fire/jenkins/builder`. To experiment with that code, run `jb` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fire-jenkins-builder'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fire-jenkins-builder
+
+## Usage
+
+cli :
+
+```sh
+jb -p PATH -b BRANCH -l LOG_LEVEL
+```
+
+添加如下配置文件至目标根目录下：
+
+```yml
+# jenkins job 配置文件
+# 可以通过在 commit 中添加 prefix ，使 CI 出发 jenkins job 的创建/构建行为
+# 提交 commit 信息
+# [jb] XXXXXX 执行 jenkins job ，如果不存在 job ，则会在对应 job_view 下创建并执行
+#
+########################
+#         选填
+########################
+# job 参数
+# 添加自己的钉钉消息等健值对
+# 需要注意的是，这里面的配置，模版必须已经存在了，这里只是修改对应的值
+parameters:
+  REPORTER_ACCESS_TOKEN: XXXXXX
+  DEBUG: true
+
+########################
+#         必填
+########################
+# 打包 job 名称 / 前缀名
+# 如果 job_name 为空，则采用 job_name_prefix + 分支名称
+# job_name: XXXX
+job_name_prefix: ZGiOS_
+# jenkins 上的分组，对应 view
+job_view: 掌柜iOS
+
+# jenkins 用户名密码
+username: qingmu
+password: xxx
+
+# 各业务线采用不同的模版，配置这里
+# 模版工程名称（需要唯一）
+template_job_name: ZGiOS_develop
+
+# 这里不动
+server_url: 'http://jenkins-shopkeeper-client.2dfire.net'
+server_port: 80
+```
+
+配置 `.gitlab-ci.yml` :
+
+```sh
+stages:
+...
+  - build
+...
+
+...
+jenkins_build:
+	before_script:
+	  - gem install jenkins_api_client
+	  - gem install nokogiri
+  stage: build
+  only:
+    variables:
+      - $CI_COMMIT_MESSAGE =~ /^\[jb\]/
+  script: 
+    - jb -p .fire-jenkins.yml -b $CI_COMMIT_REF_NAME
+  tags:
+    - iOSCI
+  allow_failure: true
+...
+```
+
+提交如下 commit 就会触发 jenkins 打包：
+
+```
+git commit -m "[jb] XXXXXX"
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/fire-jenkins-builder. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Fire::Jenkins::Builder project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/fire-jenkins-builder/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/jb

@@ -0,0 +1,44 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "optparse"
+require "fire/jenkins/builder"
+# 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
+
+options = {}
+OptionParser.new do |opts|
+	opts.banner = "jb is a tool to build jenkins job on gitlab CI."
+
+	opts.on('-p PATH', '--path PATH', 'config file path.') do |value|
+		options[:path] = value
+	end
+	
+	opts.on('-b BRANCH', '--branch BRANCH', 'jenkins branch sprcifier.') do |value|
+		options[:branch] = value
+	end
+
+	opts.on('-l LOG_LEVEL', '--log_level LOGGER_LEVEL', 'log level of jb.') do |value|
+		options[:log_level] = value
+	end
+end.parse!
+
+config_path = options[:path]
+
+raise "必须指定配置文件路径，模版见 git homepage" if config_path.nil? || !File.exist?(config_path)
+
+config = YAML.load_file(config_path)
+
+config.merge!({
+	'branch' => options[:branch],
+	'log_level' => options[:log_level]
+})
+
+builder = Fire::Jenkins::Builder::Base.new(config)
+builder.build
+# require "irb"
+# IRB.start(__FILE__)

data/fire-jenkins-builder.gemspec

@@ -0,0 +1,28 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "fire/jenkins/builder/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "fire-jenkins-builder"
+  spec.version       = Fire::Jenkins::Builder::VERSION
+  spec.authors       = ["tripleCC"]
+  spec.email         = ["triplec.linux@gmail.com"]
+
+  spec.summary       = %q{2dfire jenkins builder tool.}
+  spec.description   = %q{2dfire jenkins builder tool.}
+  spec.homepage      = "https://github.com/tripleCC/fire-jenkins-builder"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "nokogiri"
+  spec.add_dependency "jenkins_api_client"
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/fire/jenkins/builder/version.rb

@@ -0,0 +1,7 @@
+module Fire
+  module Jenkins
+    module Builder
+      VERSION = "0.1.0"
+    end
+  end
+end

data/lib/fire/jenkins/builder.rb

@@ -0,0 +1,89 @@
+require 'jenkins_api_client'
+require 'nokogiri'
+require 'fileutils'
+require 'pathname'
+require "fire/jenkins/builder/version"
+
+module Fire
+  module Jenkins
+    module Builder
+    	class Base
+				attr_reader :config
+				attr_reader :client
+
+				REQUIRED_KEYS = %w[server_url server_port username password template_job_name job_view branch].freeze
+
+				def initialize(config)
+					@client = JenkinsApi::Client.new(
+						server_url: config['server_url'], 
+						server_port: config['server_port'],
+						username: config['username'], 
+						password: config['password'],
+						log_level: config['log_level'] || 'info'
+						)
+					@config = config || {}
+					validate!
+				end
+
+				def create
+					client.job.create_or_update(job_name, target_xml)
+					client.view.add_job(config['job_view'], job_name)
+					build
+				end
+
+				def build
+					jobs = client.job.list(job_name)
+					if jobs.empty?
+						create
+					else
+						job_name = client.job.chain(jobs, 'success', ['all'])[0]
+						client.job.build(job_name, config['parameters'])
+					end
+				end
+
+				def job_name
+					@job_name = begin
+						(config['job_name'] || (config['job_name_prefix'] + config.branch)).sub('/', '_')
+					end
+				end
+
+				private
+
+				def target_xml
+					job_config = client.job.get_config(config['template_job_name'])		
+					parameters = config['parameters'] || []
+
+					doc = Nokogiri::XML(job_config)
+					properties = doc.search('//parameterDefinitions')
+					properties.children.each do |child|
+						next if child.children.empty?
+
+						children = child.children.reject { |c| c.name.nil? }
+						matched = false
+						defaultValue = nil
+						children.each do |c|
+							if c.name == 'name' && parameters.keys.include?(c.content)
+								matched = true 
+								defaultValue = parameters[c.content]
+							end
+
+							c.content = defaultValue if matched && c.name == 'defaultValue'
+						end
+					end
+
+					branch_spec_node = doc.search("//hudson.plugins.git.BranchSpec")
+					branch_node = branch_spec_node.children.find { |c| c.name == 'name' }
+					branch_node.content = config.branch
+					doc.to_xml
+				end
+
+				def validate! 
+					raise "job_name 和 job_name_prefix 必须有一个不为空" if config['job_name'].nil? && config['job_name_prefix'].nil?
+
+					empty_value_keys = REQUIRED_KEYS.select { |key| config[key].nil? }
+					raise "#{empty_value_keys.join(', ')} 不能为空" if empty_value_keys.any?
+				end
+			end
+		end
+  end
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: fire-jenkins-builder
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- tripleCC
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-11-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jenkins_api_client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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'
+description: 2dfire jenkins builder tool.
+email:
+- triplec.linux@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".fire-jenkins.yml"
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/jb
+- fire-jenkins-builder.gemspec
+- lib/fire/jenkins/builder.rb
+- lib/fire/jenkins/builder/version.rb
+homepage: https://github.com/tripleCC/fire-jenkins-builder
+licenses:
+- MIT
+metadata: {}
+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.14
+signing_key: 
+specification_version: 4
+summary: 2dfire jenkins builder tool.
+test_files: []