Created
September 7, 2021 03:41
-
-
Save fedejordan/0b7ddab87b6af720796124ab8caaf909 to your computer and use it in GitHub Desktop.
Blog14 - Custom action with Github Status API POST
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| module Fastlane | |
| module Actions | |
| class PublishCodeCoverageAction < Action | |
| COVERAGE_FILE_PATH = 'fastlane/code_coverage/index.html' | |
| def self.run(params) | |
| UI.message "Generating Slather report" | |
| Actions::SlatherAction.run( | |
| scheme: 'CodeCoverageStatusCheck', | |
| proj: 'CodeCoverageStatusCheck.xcodeproj', | |
| output_directory: "fastlane/code_coverage", | |
| html: true | |
| ) | |
| UI.message "Obtaining coverage number" | |
| code_coverage = get_code_coverage() | |
| UI.message "Code coverage: #{code_coverage}" | |
| UI.message "Getting commit SHA" | |
| commit_sha = get_current_commit_sha() | |
| UI.message "Current commit SHA: #{commit_sha}" | |
| UI.message "Publishing coverage on Github" | |
| publish_to_github("Code coverage: #{code_coverage}", commit_sha) | |
| end | |
| def self.get_code_coverage | |
| # Coverage file path | |
| current_dir = Dir.pwd | |
| complete_coverage_file_path = "#{current_dir}/#{COVERAGE_FILE_PATH}" | |
| UI.message "Coverage file path: #{complete_coverage_file_path}" | |
| # Strings between coverage number | |
| first_term = "id=\"total_coverage\">" | |
| second_term = "</span>" | |
| # Check file existence and find coverage | |
| begin | |
| file = File.open(complete_coverage_file_path) | |
| file_data = file.read | |
| first_string = file_data.split(first_term, -1)[1] | |
| final_string = first_string.split(second_term, -1)[0] | |
| return final_string | |
| rescue Errno::ENOENT | |
| return nil | |
| end | |
| end | |
| def self.get_current_commit_sha | |
| commit_info = LastGitCommitAction.run(nil) | |
| commit_info[:commit_hash] | |
| end | |
| def self.publish_to_github(message, commit_sha) | |
| GithubApiAction.run( | |
| server_url: "https://api.github.com", | |
| api_token: ENV["GITHUB_API_TOKEN"], | |
| http_method: "POST", | |
| path: "/repos/fedejordan/code-coverage-status-check/statuses/#{commit_sha}", | |
| raw_body:"{\"state\":\"success\", \"description\": \"#{message}\", \"context\": \"coverage\"}", | |
| error_handlers: { | |
| 404 => proc do |result| | |
| UI.message("Couldn't find resource: #{result[:json]}") | |
| end, | |
| '*' => proc do |result| | |
| UI.message("Unknown error: #{result[:json]}") | |
| end | |
| } | |
| ) do |result| | |
| UI.message("Code coverage updated for commit #{commit_sha}") | |
| end | |
| end | |
| ##################################################### | |
| # @!group Documentation | |
| ##################################################### | |
| def self.description | |
| "Publish code coverage to a Github commit status check" | |
| end | |
| def self.details | |
| "This action uses Slather to generate a code coverage report for the current Xcode project status, gets the coverage number, gets the current commit and publish the coverage number via Github API to a status check, making it available to see in pull requests, for example" | |
| end | |
| def self.authors | |
| ["Federico Jordan"] | |
| end | |
| def self.is_supported?(platform) | |
| platform == :ios | |
| end | |
| end | |
| end | |
| end |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment