ykcitool 0.4.9

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: be92c75c709e36699e0f5eb29e3aa36568c530c9429799df6a691fed6b2b0875
+  data.tar.gz: 7a798df020326ca43df8cc7ac31b3a5c2f98bddfdb884f5272c532d8e5322acf
+SHA512:
+  metadata.gz: a39154f25a2e572c4e3d69c248b8b63eef16fd44824b1a0f9d50771ca9a28a9d4711833ff406ae80fb90c39d50bb27ff1dd98cbd3ef4120dcb715b3dbe3fbb20
+  data.tar.gz: cc4cf873358b63985af95096455ad5c58ae776cf869ecea3c3a15362b1c742eae38bc5fa7574b16213d67d59a20f1ddb5594b5031c3589fe157f6c1c8345d01e

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 stephen.chen
+
+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,253 @@
+# Ykfastlane
+
+iOS 通用打包工具的终端门户工具
+
+- [Ykfastlane](#ykfastlane)
+  - [Installation](#installation)
+  - [Usage](#usage)
+    - [基础配置](#基础配置)
+    - [证书管理](#证书管理)
+    - [打包](#打包)
+  - [异常情况处理](#异常情况处理)
+  - [License](#license)
+    - [建议](#建议)
+
+## Installation
+
+本指令集适用与ruby 2.7.5 ~ 3.0.3
+
+- 安装ruby
+
+ruby版本管理有两种方式 rvm 与 rbenv, 建议使用rbenv.
+安装对应的ruby版本，建议使用2.7.5；并切换ruby版本到满足需求的版本。
+
+- 安装ykfastlane
+
+```shell
+gem install ykcitool
+```
+
+- 做基础配置
+- 安装fastlane脚本
+
+## Usage
+
+安装之后，使用 ykfastlane --help 查看使用说明， 功能分为 通用配置，证书管理，打包三部分。
+
+### 基础配置
+
+基础配置帮助指令
+```shell
+ykcitool init --help
+```
+- 设置基础配置  -- ykfastlane init config
+
+    本指令集只是一个门户指令，核心打包功能是通过调用fastlane脚本来实现的。 
+
+    配置：
+  - 配置fastlane脚本的远程仓库
+  
+    此套fastlane脚本是配套脚本；考虑到github的访问问题，可将原始仓库代码迁移到gitlab仓库[^1]。[【原始仓库地址】](https://github.com/stephen5652/ykfastlane_scrip.git)
+  
+  - 配置通知机器人
+  
+    任务失败时候的，通过企业微信机器人通知开发者[^2]。[【企业微信机器人配置】](https://developer.work.weixin.qq.com/document/path/91770)
+  
+  用例：
+    ```shell
+    ykcitool init config -f https://github.com/stephen5652/ykfastlane_scrip.git -t 5ef50d9f-6426-4c4c-94f8-xxxxxxxxxxxx 
+    ```
+
+- 显示基础配置 -- ykfastlane init list_config
+
+    在终端打印基础配置的内容
+
+    用例
+    ```shell
+    ykcitool init list_config
+    ```
+
+- 同步fastlane脚本 -- ykfastlane init sync_script
+  
+    同步远端fastlane脚本，此处可以通过参数下载固定的fastlan仓库，也可以使用环境配置的仓库来下载。
+
+    用例：
+    ```shell
+    ykcitool init sync_script
+    ```
+
+### 证书管理
+
+iOS证书管理有多种方案：
+
+> - 使用app store connect API进行管理；
+> - 使用fastlane match 管理【适用于单账号】
+> - 半手动管理
+
+考虑到此平台是通用打包平台，且适用于多个Apple账号下的app打包，所以使用半自动管理证书的形式。
+具体实施方案：
+
+> - 账号管理员创建/维护签名证书和描述文件，并上传至证书仓库；
+> - 开发者电脑，打包机同步证书仓库，并安装证书和描述文件；
+> - 各个项目配置手动签名配置；
+> - 打包平台依据项目签名配置，进行打包。
+
+操作步骤：
+
+- 管理员，开发者，打包机电脑配置证书仓库
+
+    指令集通过git仓库来维护证书。
+
+    指令
+    ```shell
+    ykcitool certificate edit_config -r http://xxx.xxx.com/xxx.git
+    ```
+  
+    指令集支持显示证书仓库配置
+
+    指令：
+    ```shell
+    ykcitool certificate list_config
+    ```
+
+- 管理员更新证书
+
+    使用脚本平台，更新证书，并推送至证书仓库
+
+    指令：
+
+    ```shell
+    ykcitool certificate update_cer -c /Users/xxx/xxx/xxxx.p12 -p xxxx
+    ```
+
+- 管理员更新描述文件
+
+    使用脚本平台，更新描述文件，并推送至证书仓库。
+
+    指令：
+
+    ```shell
+    ykcitool certificate update_profile -p /Users/xxx/xxx/xxx.mobileprovision
+    ```
+
+- 同步证书和描述文件
+
+    开发者，打包机通过平台同步证书仓库。
+
+    指令：
+
+    ```shell
+    ykcitool certificate sync-cer
+    ```
+
+- 显示证书和描述文件
+
+    指令集支持显示证书仓库中的证书和描述文件
+
+    指令：
+
+    ```shell
+    ykcitool certificate list_cers
+    ```
+
+- 缺点
+
+    此种形式的证书管理，也是存在缺点的。
+
+    缺点：
+
+  - 多个Apple账号的证书在同一个git仓库管理；
+  - 每台电脑都安装了所有Apple账号的证书和项目描述文件。
+
+### 打包
+
+指令集通过调用fastlane脚本进行打包，依据发不的平台，分为三种打包：fir平台，蒲公英平台，TF
+
+- fir打包
+
+  - 打包指令帮助：
+
+    ```shell
+    ykcitool archive fire --help
+    ```
+  
+  - 使用方式
+  
+      支持两种打包方式， 在.xcworkspace 路径打包 / 在其他目录打包。
+
+      > 在 .xcworkspace 同级打包
+      > ```shell
+      > ykcitool archive fire -s XXXX -f xxxx -e enterprise -n "iOS测试包" -w xxxx
+      > ```
+
+      > 在其他目录打包：
+      由于.xcworkspace未必在git仓库根目录，所以可以用参数 -x 指定 .xcworkspace 的相对路径 </br>
+      如果终端工作路径在 .xcworkspace同级目录，则可以不使用参数 -x </br>
+      如果不用专门通知企业微信业务群，可以不指定 -w 参数，会默认使用env中配置的企微机器人。</br>
+      > ```shell
+      > ykcitool archive fire -s XXXX -x ～/users/xxx/xxx/xxxx.xcworkspace -f xxxx -e enterprise -n "iOS测试包" -w xxxx
+      > ```
+    
+- 蒲公英打包
+
+    使用方式同 fir 打包
+
+
+- TF打包
+
+    由于TF打包一定是app store包，所以此指令没有 -e 参数，无法指定包类型
+    - 打包指令帮助：
+      ```shell
+      ykcitool archive tf --help
+      ```
+  
+    - 使用方式
+
+      通用支持两种打包方式， 通过 -x 参数来指定 .xcworkspace 的路径
+      > 此处需要特别说明 -u -p -w -c 参数 </br>
+      -u 开发者的Apple ID </br>
+      -p 开发者Apple ID的App专属密钥[^3]。[【传送门】](https://appleid.apple.com/account/manage) </br>
+      -w 企微机器人，如果不指定，则默认使用env中配置的机器人。 </br>
+      -c 是否需要pod install， 默认不执行。
+    
+      指令范例：
+      ```shell
+      ykcitool archive tf -s XXX -u xxxx.@xxx.com  -p xxxx-xxxx-xxxx-xxxx -n iOS测试包 -w xxxxx -c 1
+      ```
+
+## 异常情况处理
+
+- public_suffix 版本冲突
+
+  - 清空gem
+  
+    ```shell
+    gem clean
+    ```
+
+  - 卸载 public_suffix
+
+    ```shell
+    gem uninstall public_suffix
+    ```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+[^1]:fastlane脚本原始仓库地址: https://github.com/stephen5652/ykfastlane_scrip.git
+
+[^2]:企业微信机器人配置网址: https://developer.work.weixin.qq.com/document/path/91770
+
+[^3]: 配置App专属密钥的网址: https://appleid.apple.com/account/manage
+
+
+### 建议
+
+fire-api-token 做全局配置
+
+tf tag参数化，可以控制是否打tag
+
+builde 号不交付苹果管理，指令集也不管理，交由工程配置
+
+显示打包结果的存储路径

data/bin/ykcitool

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+
+puts "call ykcitool"
+
+lib = File.expand_path(File.dirname(__FILE__) + '/../lib')
+$LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
+
+# 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 'interface'
+puts "call ykcitool:#{YKFastlane::VERSION}"
+
+puts "ykcitool start"
+YKFastlane::Interface.start(ARGV)

data/lib/GitTools/git_analysis.rb

@@ -0,0 +1,109 @@
+require 'ykfastlane/helper'
+
+require 'git'
+require 'json'
+
+module YKFastlane
+  module GitAnalysis
+    include Git
+
+    def self.commit_tag_diff(path)
+      git = Git::open(path)
+      last_tag = self.last_tag_on_branch(git)
+      tag_name = last_tag.name unless last_tag == nil
+
+      tag_commit = last_tag.log(1).last unless last_tag == nil
+      tag_commit = git.log(0x7fffffff).last if tag_commit == nil
+      tag_sha = tag_commit.sha unless tag_commit == nil
+
+      cur_commit = git.log(1).first
+      cur_sha = cur_commit.sha unless cur_commit == nil
+
+      diff = self.diff_between?(path, tag_sha, cur_sha)
+
+      result = {
+        :tag_name => tag_name,
+      }
+      result.update(diff)
+      result
+    end
+
+
+    def commit_tag_diff(path)
+    YKFastlane::GitAnalysis.commit_tag_diff(path)
+    end
+
+    private
+
+    def self.sha_existed?(git, sha)
+      result = true
+      begin
+        start_type = git.lib.object_type(sha)
+      rescue Git::GitExecuteError => e
+        result = false
+      end
+      result
+    end
+
+    def self.diff_between?(path, id_start, id_end)
+      git = Git::open(path)
+
+      # id_start = "0d5e5d4d7e8f8a9b" #debug code
+      # id_end = "2347682023948" #debug code
+      status = true
+      msg_arr = []
+      if self.sha_existed?(git, id_start) == false
+        status = false
+        msg_arr << id_start
+      end
+
+      if self.sha_existed?(git, id_end) == false
+        status = false
+        msg_arr << id_end
+      end
+
+      msg = "success"
+      msg = "diff check failed, since commit not existed: " + msg_arr.join(" ") unless status == true
+
+      diff = nil
+      if status
+        c_start = git.gcommit(id_start)
+        c_end = git.gcommit(id_end)
+        diff = git.diff(c_start, c_end) #Git::Diff
+      end
+
+
+      remotes = git.remotes
+      remote_dict = {}
+      remotes.each do |one|
+        #Git::Remote
+        remote_dict[one.name] = one.url
+      end
+      result = {
+        :status => status,
+        :message => msg,
+        :remote_info => remote_dict,
+        :start_commit => id_start,
+        :end_commit => id_end,
+        :stats => diff == nil ? {} : diff.stats,
+      }
+
+      puts("diff_detail:#{result.to_json}")
+      result
+    end
+
+    def self.last_tag_on_branch(git)
+      last_tag_name = nil
+
+      begin
+        last_tag_name = git.describe(nil, { :abbrev => 0 })
+      rescue Git::GitExecuteError => e
+        puts "find last tag failed:#{e}"
+      end
+      tag = git.tag(last_tag_name) unless last_tag_name.blank?
+
+      tag
+    end
+
+  end
+end

data/lib/HttpService/HttpServiceHelper.rb

@@ -0,0 +1,28 @@
+require 'ykfastlane/helper'
+require 'actions/init'
+
+require 'agoo'
+module YKHttpModule
+  module YKHttpHelper
+
+    require 'HttpService/git_tag_analysis_handler'
+
+    def self.startService(port)
+      puts("should start http service at port:#{port}")
+      Agoo::Server.init(6464, 'root')
+
+      tag_diff = YKHttpModule::GitTagDiff.new
+      Agoo::Server.handle(:POST, "/tag_diff", tag_diff)
+
+      commit_diff = YKHttpModule::GitCommitDiff.new
+      Agoo::Server.handle(:GET, "/commit_diff", commit_diff)
+
+      Agoo::Server.start()
+
+    end
+
+    def self.stopService()
+      puts("should stop http service")
+    end
+  end
+end

data/lib/HttpService/git_tag_analysis_handler.rb

@@ -0,0 +1,20 @@
+module YKHttpModule
+  require 'GitTools/git_analysis'
+
+  class GitTagDiff
+    def call(req)
+      puts("tag_diff[#{self}]:#{req}")
+      [ 200, { }, [ "#{req}" ] ]
+    end
+  end
+
+  class GitCommitDiff
+    def call(req)
+      puts("commit_diff[#{self}]:#{req}")
+      YKFastlane::Init.new().list_all_configs
+      path = Dir.pwd
+      result = YKFastlane::GitAnalysis.commit_tag_diff(path)
+      [ 200, { }, [ "#{result}" ] ]
+    end
+  end
+end

data/lib/actions/YKFastlaneExecute.rb

@@ -0,0 +1,89 @@
+require 'rails'
+require 'thor'
+
+require "ykfastlane/helper"
+
+module YKFastlane
+
+  class SubCommandBase < Thor
+    class_option :verbose, :type => :boolean
+    def self.exit_on_failure?
+      true
+    end
+
+    def self.banner(command, namespace = nil, subcommand = false)
+      "#{basename} #{subcommand_prefix} #{command.usage}"
+    end
+
+    def self.subcommand_prefix
+      self.name.gsub(%r{.*::}, '').gsub(%r{^[A-Z]}) { |match| match[0].downcase }.gsub(%r{[A-Z]}) { |match| "-#{match[0].downcase}" }
+    end
+  end
+
+  class YKFastlaneExecute
+    def self.executeCommand(commandShell_pre, commandShell, workTitle)
+      excuteStr = " "
+      excuteStr << "#{commandShell_pre}" unless commandShell_pre.blank?
+      excuteStr << " && #{commandShell}" unless commandShell.blank?
+
+      puts "START COMMAND:#{excuteStr}"
+      code = 1
+      system(excuteStr)
+      result = $?
+      puts "command result[#{result.class}]:#{result}"
+      code = result.exitstatus if result.is_a?(Process::Status)
+
+      #### 以下代码注释，因为fastlane脚本中做了任务失败时候的通知
+      # if code != 0
+      #   #任务失败, 此处需要发送企业微信的通知到开发群
+      #   puts "should report error to developer group"
+      #   noticeCmd = commandShell_pre
+      #   commandShell = commandShell.gsub!( " ", "\\ " )
+      #   commandShell = commandShell.gsub!( "\"", "\\\"")
+      #   noticeCmd << "&&fastlane wx_message_notice wx_notice_token:#{Helper::YKWECHAT_ROBOT_TOKEN} msg_title:\"CI work failed\" notice_message:\"#{commandShell}\""
+      #   puts "notice_command:#{noticeCmd}"
+      #   system(noticeCmd)
+      # end
+
+      code
+    end
+
+    def self.exchangOptionMapToStr(optionHash)
+      paras = {}
+      optionHash.each_pair { |k, v| paras[k] = v }
+      puts "paras:#{paras.dup}"
+
+      puts "YKRUNING_PATH:#{Helper::YKRUNING_PATH}"
+      workspace_path = Helper::YKRUNING_PATH
+      workspace_path = paras["xcworkspace"] unless paras["xcworkspace"].blank?
+      paras[:xcworkspace] = workspace_path
+      paras[:script_run_path] = Helper::YKRUNING_PATH
+
+      puts "options_after:#{paras}"
+      option_str = ""
+      paras.each_pair do |k, v|
+        option_str << " #{k}:\"#{v}\""
+      end
+      option_str
+    end
+
+    def self.executeFastlaneLane(lane_name, optionHash)
+      dict = {}
+      dict.update(optionHash)
+      if optionHash[:wxwork_access_token].blank?
+        wxtoken = YKFastlane::Helper.load_config_value(YKFastlane::Helper::K_wx_access_token)
+        dict.update({:wxwork_access_token => wxtoken})
+      end
+
+      option_str = exchangOptionMapToStr(dict)
+      command = "fastlane #{lane_name} #{option_str}" unless option_str.blank?
+
+      command_pre = "export LANG=en_US.UTF-8 && export LANGUAGE=en_US.UTF-8 && export LC_ALL=en_US.UTF-8 && which ruby"
+      command_pre << " && cd #{YKFastlane::Helper.fastlane_script()}"
+
+      executeCommand(command_pre, command, lane_name)
+    end
+
+  end
+
+end