fastlane-plugin-xclogparser 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8c60a3ced6bc8e096a89294999b757a4bd9590f6393136c3c0f3ff8824b04be7
+  data.tar.gz: aec579379d2d2bb77e590b248de6be93925ea4e2315d489e142e6a603b416e3a
+SHA512:
+  metadata.gz: addc93f71f80a7b1b8a5fcbc8368331cdbf386d40e1445a84d626b7464b1e380cf2d411b803315dc605df3eaa4395bb0c10563cb6299f07fd367c04a060632ee
+  data.tar.gz: 3105170a530d0423e6458a600bfdd3a63bf46bcc972cf8b316e4eff7885322cc3e8a420429715f992360e4e57a461ffbf42aa1a2e3e52fd41e557c1a1339b4ee

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Hudl
+
+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,46 @@
+# xclogparser plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-xclogparser)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-xclogparser`, add it to your project by running:
+
+```bash
+fastlane add_plugin xclogparser
+```
+
+## About xclogparser
+
+[XCLogParser](https://github.com/spotify/XCLogParser) is a CLI tool that parses the SLF serialization format used by Xcode and xcodebuild to store its Build and Test logs (xcactivitylog files). This plugin provides an easy way to run XCLogParser against your builds.
+
+It is a prerequisite that `XCLogParser` is installed globally on the same machine that will be executing your Fastfile. You can find the install instruction [here](https://github.com/spotify/XCLogParser#installation) or install with `brew install xclogparser`
+
+## 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://docs.fastlane.tools/plugins/plugins-troubleshooting/) guide.
+
+## Using _fastlane_ Plugins
+
+For more information about how the `fastlane` plugin system works, check out the [Plugins documentation](https://docs.fastlane.tools/plugins/create-plugin/).
+
+## About _fastlane_
+
+_fastlane_ is the easiest way to automate beta deployments and releases for your iOS and Android apps. To learn more, check out [fastlane.tools](https://fastlane.tools).

data/lib/fastlane/plugin/xclogparser.rb

@@ -0,0 +1,16 @@
+require 'fastlane/plugin/xclogparser/version'
+
+module Fastlane
+  module Xclogparser
+    # 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::Xclogparser.all_classes.each do |current|
+  require current
+end

data/lib/fastlane/plugin/xclogparser/actions/xclogparser_action.rb

@@ -0,0 +1,96 @@
+require 'fastlane/action'
+require_relative '../helper/xclogparser_helper'
+require 'time'
+
+module Fastlane
+  module Actions
+    class XclogparserAction < Action
+      def self.run(params)
+        Helper::XclogparserHelper.check_if_installed
+
+        command = params[:command].downcase
+
+        if command.eql?('parse')
+          options = params[:options]
+          if options == "" || options == [] || options.nil?
+            UI.user_error!("--reporter and one of --file, --project, --workspace, --xcodeproj parameters is required.\nSee https://github.com/spotify/XCLogParser#parse-command for more information about the Parse command.")
+          end
+          options = format_options(options)
+        end
+
+        xclogparse_command = ['xclogparser', command, options].compact.join(" ")
+
+        begin
+          xclogparse_output = Action.sh(xclogparse_command)
+        rescue FastlaneCore::Interface::FastlaneShellError => e
+          if e.message.include?("//Logs/Build")
+            UI.error("Since Xcode 11, `xcodebuild` only generates the .xcactivitylog build logs when the option --resultBundlePath. If you're compiling with that command and not with Xcode, be sure to set that option to a valid path")
+          end
+          UI.user_error!(e.message)
+        end
+
+        if params[:zip_html_report]
+          report_directory = File.dirname(parse_output_for_html_report(xclogparse_output))
+          report_time = Time.parse(File.basename(report_directory))
+          zip_name = "xclogparser_report_#{report_time.strftime('%Y-%m-%d-%H%M%S')}.zip"
+          zip_path = File.join(Dir.pwd, zip_name)
+          Dir.chdir(report_directory) do
+            Action.sh("zip -r -X #{zip_path} .")
+          end
+          xclogparse_output = zip_path
+        end
+        xclogparse_output
+      end
+
+      def self.format_options(options)
+        if options.kind_of?(Array)
+          options.map! { |i| i.include?("--") ? i : "--#{i}" }
+        else
+          options.include?("--") ? options : "--#{options}"
+        end
+      end
+
+      def self.parse_output_for_html_report(unparsed_output)
+        # XCLogParser outputs a formatted string to the report path.
+        unparsed_output.split("Report written to ")[1]
+      end
+
+      def self.description
+        "Parse Xcode or xcodebuild build and test logs with XCLogParser"
+      end
+
+      def self.authors
+        ["Josh Lesch"]
+      end
+
+      def self.details
+        "XCLogParser is a CLI tool that parses the SLF serialization format used by Xcode and xcodebuild to store its Build and Test logs (xcactivitylog files). This plugin provides an easy way to run XCLogParser against your builds."
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :command,
+                                       description: "XCLogParse command to execute. Run `xclogparse help` to list available commands",
+                                       default_value: "parse",
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :options,
+                                       description: "Options for the XCLogParse command. Can be a string for a single option or a list of options",
+                                       is_string: false,
+                                       optional: true,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("Invalid option: #{value.inspect}, must be an Array or String") unless value.instance_of?(String) || value.instance_of?(Array)
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :zip_html_report,
+                                       description: "Zip Html if generated",
+                                       is_string: false,
+                                       default_value: false,
+                                       optional: true)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        [:ios, :mac].include?(platform)
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/xclogparser/helper/xclogparser_helper.rb

@@ -0,0 +1,34 @@
+require 'fastlane_core/ui/ui'
+require 'net/http'
+require 'json'
+
+module Fastlane
+  UI = FastlaneCore::UI unless Fastlane.const_defined?("UI")
+
+  module Helper
+    class XclogparserHelper
+      def self.check_if_installed
+        command = ['xclogparser', 'version']
+        begin
+          version = Action.sh(command).match(/(\d+\.)?(\d+\.)?(\d+)/)[0]
+        rescue Errno::ENOENT => e
+          raise e unless e.message.include?("No such file or directory - xclogparser")
+          UI.user_error!("Could not find XCLogParser. Please install using `brew install xclogparser` or verify that it is installed correctly.")
+        end
+        check_for_updates(version)
+      end
+
+      def self.check_for_updates(installed_version)
+        command = ['brew', 'outdated', 'xclogparser', '--json']
+        # Brew returns a non-zero exit code if the formula is outdated
+        res = Actions.sh(command, log: false, error_callback: ->(result) {})
+        json_res = JSON.parse(res)
+        return if json_res.empty?
+        UI.important("\n#############################################################\n"\
+                     "#  XCLogParser #{json_res[0]['current_version']} is available. You are on #{installed_version}.\n"\
+                     "#  You can update using `brew upgrade xclogparser`    "\
+                     "\n#############################################################")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+module Fastlane
+  module Xclogparser
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-xclogparser
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Josh Lesch
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-06-09 00:00:00.000000000 Z
+dependencies:
+- !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: rspec_junit_formatter
+  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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-require_tools
+  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: simplecov
+  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: 2.149.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.149.1
+description:
+email: josh.lesch@hudl.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/xclogparser.rb
+- lib/fastlane/plugin/xclogparser/actions/xclogparser_action.rb
+- lib/fastlane/plugin/xclogparser/helper/xclogparser_helper.rb
+- lib/fastlane/plugin/xclogparser/version.rb
+homepage: https://github.com/hudl/fastlane-plugin-xclogparser
+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: []
+rubygems_version: 3.0.8
+signing_key:
+specification_version: 4
+summary: Parse Xcode or xcodebuild build and test logs with XCLogParser
+test_files: []