fastlane-plugin-ci_changelog 0.3.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 95272b437c9ae47e6a89df01015e26ec68130ada
+  data.tar.gz: 8ba9ab57641347793a0d4eed606f084bb661c6b8
+SHA512:
+  metadata.gz: b37c8b5c47b5b37a4d03a23b7946e058fc7e6f88822481f6d5b29590321401b0541a103e254aacfe7b59e89755619ce8978d7848e8acf020e13008e2c2312f02
+  data.tar.gz: 4b4bca65f6b3028e82c1f1567223c826c33f6a7323c20fc9a1a3569f34611b9c6d8ce3a602a06929bb55dc4d943d99cc55056e16c7706b2a9c0bd25d9db2cf46

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 icyleaf <icyleaf.cn@gmail.com>
+
+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,54 @@
+# ci_changelog plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-ci_changelog)
+
+## Getting Started
+
+This project is a [fastlane](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-ci_changelog`, add it to your project by running:
+
+```bash
+fastlane add_plugin ci_changelog
+```
+
+## About ci_changelog
+
+Automate generate changelog between previous and the latest commit of scm during the ci system
+
+### Available CI system:
+
+- [x] Jenkins
+- [x] Gitlab CI
+- [ ] Travis CI
+
+## Example
+
+Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plugin. Try it by cloning the repo, running `fastlane install_plugins` and `bundle exec fastlane test`.
+
+## Run tests for this plugin
+
+To run both the tests, and code style validation, run
+
+```
+rake
+```
+
+To automatically fix many of the styling issues, use
+```
+rubocop -a
+```
+
+## Issues and Feedback
+
+For any other issues and feedback about this plugin, please submit it to this repository.
+
+## Troubleshooting
+
+If you have trouble using plugins, check out the [Plugins Troubleshooting](https://github.com/fastlane/fastlane/blob/master/fastlane/docs/PluginsTroubleshooting.md) doc in the main `fastlane` repo.
+
+## Using `fastlane` Plugins
+
+For more information about how the `fastlane` plugin system works, check out the [Plugins documentation](https://github.com/fastlane/fastlane/blob/master/fastlane/docs/Plugins.md).
+
+## About `fastlane`
+
+`fastlane` is the easiest way to automate building and releasing your iOS and Android apps. To learn more, check out [fastlane.tools](https://fastlane.tools).

data/lib/fastlane/plugin/ci_changelog.rb

@@ -0,0 +1,16 @@
+require 'fastlane/plugin/ci_changelog/version'
+
+module Fastlane
+  module CiChangelog
+    # Return all .rb files inside the "actions" and "helper" directory
+    def self.all_classes
+      Dir[File.expand_path('**/{actions,helper}/*.rb', File.dirname(__FILE__))]
+    end
+  end
+end
+
+# By default we want to import all available actions and helpers
+# A plugin can contain any number of actions and plugins
+Fastlane::CiChangelog.all_classes.each do |current|
+  require current
+end

data/lib/fastlane/plugin/ci_changelog/actions/ci_changelog_action.rb

@@ -0,0 +1,224 @@
+require 'rest-client'
+require 'uri'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      CICL_CI = :CICL_CI
+      CICL_PROJECT_URL = :CICL_PROJECT_URL
+      CICL_BRANCH = :CICL_BRANCH
+      CICL_COMMIT = :CICL_COMMIT
+      CICL_CHANGELOG = :CICL_CHANGELOG
+    end
+
+    module CICLType
+      JENKINS = 'Jenkins'
+      GITLAB_CI = 'Gitlab CI'
+      TRAVIS_CI = 'Travis CI'
+      UNKOWEN = 'unkown'
+    end
+
+    class CiChangelogAction < Action
+      def self.run(params)
+        return UI.message('No detect CI environment') unless FastlaneCore::Helper.is_ci?
+
+        @params = params
+        if Helper::CiChangelogHelper.jenkins?
+          UI.message('detected: jenkins')
+          Helper::CiChangelogHelper.determine_jenkins_options!(params)
+          fetch_jenkins_changelog!
+          fetch_jenkins_env!
+        elsif Helper::CiChangelogHelper.gitlab?
+          UI.message('detected: gitlab ci')
+          Helper::CiChangelogHelper.determine_gitlab_options!(params)
+          fetch_gitlab_changelog!
+          fetch_gitlab_env!
+        else
+          Helper::CiChangelogHelper.store_sharedvalue(SharedValues::CICL_CI, CICLType::UNKOWEN)
+          UI.message('Sorry, No found CI variable, maybe not support yet, available is Jenkins/Gitlab CI')
+        end
+
+        print_table! unless params[:silent]
+      end
+
+      def self.print_table!
+        changelog =
+          if !Actions.lane_context[SharedValues::CICL_CHANGELOG].nil? or !Actions.lane_context[SharedValues::CICL_CHANGELOG].empty?
+            JSON.parse(Actions.lane_context[SharedValues::CICL_CHANGELOG]).each_with_object([]) do |commit, obj|
+              obj << commit.collect { |k, v| "#{k}: #{v}" }.join("\n")
+            end.join("\n\n")
+          else
+            'No found'
+          end
+
+        params = {
+          title: "Summary for ci_changelog #{CiChangelog::VERSION}".green,
+          rows: {
+            ci: Actions.lane_context[SharedValues::CICL_CI],
+            project_url: Actions.lane_context[SharedValues::CICL_PROJECT_URL],
+            branch: Actions.lane_context[SharedValues::CICL_BRANCH],
+            commit: Actions.lane_context[SharedValues::CICL_COMMIT],
+            changelog: changelog
+          }
+        }
+
+        puts ""
+        puts Terminal::Table.new(params)
+        puts ""
+      end
+
+      def self.fetch_jenkins_changelog!
+        commits = []
+        loop_count = 1
+        fetch_correct_changelog = false
+
+        build_number = ENV['BUILD_NUMBER'].to_i
+        loop do
+          build_url = "#{ENV['JOB_URL']}/#{build_number}/api/json"
+          res =
+            if Helper::CiChangelogHelper.determine_jenkins_basic_auth?
+              RestClient::Request.execute(
+                method: :get,
+                url: build_url,
+                user: @params.fetch(:jenkins_user),
+                password: @params.fetch(:jenkins_token)
+              )
+            else
+              RestClient.get(build_url)
+            end
+
+          if res.code == 200
+            build_status, data = Helper::CiChangelogHelper.dump_jenkin_commits(res.body)
+
+            if build_status == true
+              commits = data
+              fetch_correct_changelog = true
+            else
+              commits = commits.empty? ? data : commits.concat(data)
+              loop_count += 1
+            end
+          end
+          build_number -= 1
+
+          break if fetch_correct_changelog || build_number <= 0
+        end
+        commits = Helper::CiChangelogHelper.git_commits(ENV['GIT_PREVIOUS_SUCCESSFUL_COMMIT']) if Helper.is_test? && commits.empty?
+
+        Helper::CiChangelogHelper.store_sharedvalue(SharedValues::CICL_CHANGELOG, commits.to_json)
+      end
+
+      def self.fetch_jenkins_env!
+        branch = ENV['GIT_BRANCH'] || ENV['SVN_BRANCH']
+        branch = branch.split('/')[1..-1].join('/') if branch.include?('/') # fix origin/xxxx
+
+        Helper::CiChangelogHelper.store_sharedvalue(SharedValues::CICL_CI, CICLType::JENKINS)
+        Helper::CiChangelogHelper.store_sharedvalue(SharedValues::CICL_BRANCH, branch)
+        Helper::CiChangelogHelper.store_sharedvalue(SharedValues::CICL_COMMIT, ENV['GIT_COMMIT'])
+        Helper::CiChangelogHelper.store_sharedvalue(SharedValues::CICL_PROJECT_URL, ENV['JOB_URL'])
+      end
+
+      def self.fetch_gitlab_changelog!
+        commits = []
+        loop_count = 1
+        fetch_correct_changelog = false
+
+        build_number = ENV['CI_BUILD_ID'].to_i
+        loop do
+          build_url = "#{@params[:gitlab_url]}/api/v3/projects/#{ENV['CI_PROJECT_ID']}/builds/#{build_number}"
+          res = RestClient.get(build_url, { 'PRIVATE-TOKEN' => @params[:gitlab_private_token] })
+
+          if res.code == 200
+            build_status, data = Helper::CiChangelogHelper.dump_gitlab_commits(res.body)
+
+            if build_status == true
+              commits = data if commits.empty?
+              fetch_correct_changelog = true
+            else
+              commits = commits.empty? ? data : commits.concat(data)
+              loop_count += 1
+            end
+          end
+          build_number -= 1
+
+          break if fetch_correct_changelog || build_number <= 0
+        end
+
+        Helper::CiChangelogHelper.store_sharedvalue(SharedValues::CICL_CHANGELOG, commits.to_json)
+      end
+
+      def self.fetch_gitlab_env!
+        build_url =
+          if ENV['CI_PROJECT_URL']
+            "#{ENV['CI_PROJECT_URL']}/builds/#{ENV['CI_BUILD_ID']}"
+          else
+            uri = URI.parse(ENV['CI_BUILD_REPO'])
+            ci_project_namespace = ENV['CI_PROJECT_DIR'].split('/')[-2..-1].join('/')
+            url_port = uri.port == 80 ? '' : ":#{uri.port}"
+
+            "#{uri.scheme}://#{uri.host}#{url_port}/#{ci_project_namespace}/builds/#{ENV['CI_BUILD_ID']}"
+          end
+
+        Helper::CiChangelogHelper.store_sharedvalue(SharedValues::CICL_CI, CICLType::GITLAB_CI)
+        Helper::CiChangelogHelper.store_sharedvalue(SharedValues::CICL_BRANCH, ENV['CI_BUILD_REF_NAME'])
+        Helper::CiChangelogHelper.store_sharedvalue(SharedValues::CICL_COMMIT, ENV['CI_BUILD_REF'])
+        Helper::CiChangelogHelper.store_sharedvalue(SharedValues::CICL_PROJECT_URL, build_url)
+      end
+
+      def self.output
+        [
+          [SharedValues::CICL_CI.to_s, 'the name of CI'],
+          [SharedValues::CICL_BRANCH.to_s, 'the name of CVS branch'],
+          [SharedValues::CICL_COMMIT.to_s, 'the last hash of CVS commit'],
+          [SharedValues::CICL_CHANGELOG.to_s, 'the json formatted changelog of CI (datetime, message, author and email)']
+        ]
+      end
+
+      def self.description
+        "Automate generate changelog between previous build failed and the latest commit of scm in CI."
+      end
+
+      def self.details
+        "availabled with jenkins, gitlab ci, more support is comming soon."
+      end
+
+      def self.authors
+        ["icyleaf <icyleaf.cn@gmail.com>"]
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :silent,
+                                  env_name: "CICL_SILENT",
+                               description: "Hide all information of print table",
+                                  optional: true,
+                             default_value: false,
+                                 is_string: false),
+          FastlaneCore::ConfigItem.new(key: :jenkins_user,
+                                  env_name: "CICL_CHANGELOG_JENKINS_USER",
+                               description: "the user of jenkins if enabled security",
+                                  optional: true,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :jenkins_token,
+                                  env_name: "CICL_CHANGELOG_JENKINS_TOKEN",
+                               description: "the token or password of jenkins if enabled security",
+                                  optional: true,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :gitlab_url,
+                                  env_name: "CICL_CHANGELOG_GITLAB_URL",
+                               description: "the url of gitlab",
+                                  optional: true,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :gitlab_private_token,
+                                  env_name: "CICL_CHANGELOG_GITLAB_PRIVATE_TOKEN",
+                               description: "the private token of gitlab",
+                                  optional: true,
+                                      type: String)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/ci_changelog/helper/ci_changelog_helper.rb

@@ -0,0 +1,98 @@
+require 'json'
+
+module Fastlane
+  module Helper
+    class CiChangelogHelper
+      def self.show_message
+        UI.message("Hello from the ci_changelog plugin helper!")
+      end
+
+      def self.git_commits(last_success_commit)
+        git_logs = `git log --pretty="format:%s - %cn [%ci]" #{last_success_commit}..HEAD`.strip.gsub(' +0800', '')
+        git_logs.split("\n")
+      end
+
+      def self.dump_jenkin_commits(body)
+        json = JSON.parse(body)
+        commit = json['changeSet']['items'].each_with_object([]) do |item, obj|
+          obj.push({
+            date: item['date'],
+            message: item['msg'],
+            author: item['author']['fullName'].strip,
+            email: item['authorEmail'].strip
+          })
+        end
+
+        if json['result'] == 'SUCCESS'
+          [true, commit]
+        else
+          [false, commit]
+        end
+      end
+
+      def self.dump_gitlab_commits(body)
+        json = JSON.parse(body)
+        commit = {
+          date: json['commit']['created_at'],
+          message: json['commit']['message'].strip,
+          author: json['commit']['author_name'].strip,
+          email: json['commit']['author_email'].strip
+        }
+
+        if json['status'] == 'success'
+          [true, [commit]]
+        else
+          [false, [commit]]
+        end
+      end
+
+      def self.determine_gitlab_options!(options)
+        %w(gitlab_url gitlab_private_token).each do |key|
+          UI.user_error!("Missing #{key} param or empty value.") unless options.fetch(key.to_sym) && !options[key.to_sym].empty?
+        end
+      end
+
+      def self.determine_jenkins_options!(options)
+        if determine_jenkins_basic_auth?
+          %w(jenkins_user jenkins_token).each do |key|
+            UI.user_error!("Missing #{key} param or empty value.") unless options.fetch(key.to_sym) && !options[key.to_sym].empty?
+          end
+        end
+      end
+
+      def self.determine_jenkins_basic_auth?
+        res = RestClient.get("#{ENV['JENKINS_URL']}/api/json")
+        if res.code == 200 && res.headers[:content_type].include?('json')
+          return false
+        else
+          return true
+        end
+      rescue RestClient::Forbidden
+        return true
+      end
+
+      def self.store_sharedvalue(key, value)
+        Actions.lane_context[key] = value
+        ENV[key.to_s] = value
+
+        value
+      end
+
+      def self.jenkins?
+        %w(JENKINS_URL JENKINS_HOME).each do |current|
+          return true if ENV.key?(current)
+        end
+
+        return false
+      end
+
+      def self.gitlab?
+        ENV.key?('GITLAB_CI')
+      end
+
+      def self.travis?
+        ENV.key?('TRAVIS')
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/ci_changelog/version.rb

@@ -0,0 +1,5 @@
+module Fastlane
+  module CiChangelog
+    VERSION = '0.3.1'.freeze
+  end
+end

metadata

@@ -0,0 +1,176 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-ci_changelog
+version: !ruby/object:Gem::Version
+  version: 0.3.1
+platform: ruby
+authors:
+- icyleaf
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fastlane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.103.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.103.0
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: icyleaf.cn@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/ci_changelog.rb
+- lib/fastlane/plugin/ci_changelog/actions/ci_changelog_action.rb
+- lib/fastlane/plugin/ci_changelog/helper/ci_changelog_helper.rb
+- lib/fastlane/plugin/ci_changelog/version.rb
+homepage: https://github.com/icyleaf/fastlane-plugin-ci_changelog
+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.8
+signing_key: 
+specification_version: 4
+summary: Automate generate changelog between previous build failed and the latest
+  commit of scm in CI
+test_files: []