fastlane-plugin-xcodebuild_analyze 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4dfaf4c71556556813b654627fa6b7c17dff8fca09fdf67064d3fb14b44d8476
+  data.tar.gz: 3fd607d7c8e46db7e8003b3d9b7ec63daef39e47789918bfdfa9ff202342e7b8
+SHA512:
+  metadata.gz: 4c51b1ae4dc8b2cbf2b844a308e5932f755938dfeba022680099191b2f61e6f4b893189a84d030a58bf1c1b3dbb645aa7c0c7e312b3324d690b796c8963bd44c
+  data.tar.gz: 2aa6d3a3914c17b0c2715c7dd3b0283cc2dc09d1c93c7969ad12547793e134b309d7a158d831994bf47e8ed10c944321d1c5d195d91069c231edf0c6ea7cac45

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Meniga <mobile.dev@meniga.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,50 @@
+# xcodebuild_analyze plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-xcodebuild_analyze)
+[![Build Status](https://travis-ci.org/meniga/fastlane-plugin-xcodebuild_analyze.svg?branch=master)](https://travis-ci.org/meniga/fastlane-plugin-xcodebuild_analyze)
+[![codecov](https://codecov.io/gh/meniga/fastlane-plugin-xcodebuild_analyze/branch/master/graph/badge.svg)](https://codecov.io/gh/meniga/fastlane-plugin-xcodebuild_analyze)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-xcodebuild_analyze`, add it to your project by running:
+
+```bash
+fastlane add_plugin xcodebuild_analyze
+```
+
+## About xcodebuild_analyze
+
+Run code analyzer using xcodebuild
+
+## 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 check available lanes in `Fastfile`.
+
+## 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/xcodebuild_analyze.rb

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

data/lib/fastlane/plugin/xcodebuild_analyze/actions/ensure_no_results_from_xcodebuild_analyze_action.rb

@@ -0,0 +1,53 @@
+require 'fastlane'
+require_relative '../helper/ensure_no_results_from_xcodebuild_analyze_helper'
+
+module Fastlane
+  module Actions
+    class EnsureNoResultsFromXcodebuildAnalyzeAction < Action
+      def self.run(params)
+        Helper::EnsureNoResultsFromXcodebuildAnalyzeHelper.ensure_no_results(
+          params[:path],
+          params[:prune]
+        )
+      end
+
+      def self.category
+        :building
+      end
+
+      def self.description
+        "Check if the are any vulnerabilities under provided analyzer output path"
+      end
+
+      def self.authors
+        ["Marcin Stepnowski"]
+      end
+
+      def self.example_code
+        [
+          "ensure_no_results(path: 'Meniga/analyzer_output', prune: true)"
+        ]
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :path,
+            env_name: "ENSURE_NO_RESULTS_FROM_XCODEBUILD_ANALYZE_PATH",
+            description: "Path to analyzer output directory",
+            optional: false,
+            type: String),
+          FastlaneCore::ConfigItem.new(key: :prune,
+            env_name: "ENSURE_NO_RESULTS_FROM_XCODEBUILD_ANALYZE_PRUNE",
+            description: "Remove directory afterwards if true",
+            optional: false,
+            type: Boolean,
+            default_value: false)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        [:ios, :mac].include?(platform)
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/xcodebuild_analyze/actions/xcodebuild_analyze_action.rb

@@ -0,0 +1,87 @@
+require 'fastlane'
+require_relative '../helper/xcodebuild_analyze_helper'
+
+module Fastlane
+  module Actions
+    class XcodebuildAnalyzeAction < Action
+      def self.run(params)
+        configuration = Helper::XcodebuildAnalyzeHelper.parse_configuration(params)
+        Helper::XcodebuildAnalyzeHelper.run_analyzer(configuration, other_action)
+      end
+
+      def self.category
+        :building
+      end
+
+      def self.description
+        "Run code analyzer using xcodebuild"
+      end
+
+      def self.authors
+        ["Marcin Stepnowski"]
+      end
+
+      def self.example_code
+        [
+          "
+          xcodebuild_analyze(project: 'Meniga.xcodeproj',
+                            scheme: 'Release',
+                            sdk: 'iphonesimulator'
+                            output_dir: 'tmp',
+                            output: 'html',
+                            static_analyzer: true)
+          "
+        ]
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :workspace,
+            env_name: "XCODEBUILD_ANALYZE_WORKSPACE",
+            description: "WORKSPACE Workspace (.xcworkspace) file to use to analyze app (automatically detected in current directory)",
+            optional: true,
+            type: String),
+          FastlaneCore::ConfigItem.new(key: :project,
+            env_name: "XCODEBUILD_ANALYZE_PROJECT",
+            description: "Project (.xcodeproj) file to use to analyze app (overridden by --workspace option, if passed)",
+            optional: true,
+            type: String),
+          FastlaneCore::ConfigItem.new(key: :configuration,
+            env_name: "XCODEBUILD_ANALYZE_CONFIGURATION",
+            description: "Configuration used to analyze",
+            optional: true,
+            type: String),
+          FastlaneCore::ConfigItem.new(key: :scheme,
+            env_name: "XCODEBUILD_ANALYZE_SCHEME",
+            description: "Scheme used to analyze app",
+            optional: false,
+            type: String),
+          FastlaneCore::ConfigItem.new(key: :sdk,
+            env_name: "XCODEBUILD_ANALYZE_SDK",
+            description: "Use SDK as the name or path of the base SDK when building the project",
+            optional: true,
+            type: String),
+          FastlaneCore::ConfigItem.new(key: :static_analyzer,
+            env_name: "XCODEBUILD_ANALYZE_STATIC_ANALYZER",
+            description: "Run clang static analyzer if true",
+            optional: true,
+            type: Boolean),
+          FastlaneCore::ConfigItem.new(key: :output,
+            env_name: 'XCODEBUILD_ANALYZE_OUTPUT',
+            description: 'List of file output formats separated by -',
+            optional: true,
+            type: String),
+          FastlaneCore::ConfigItem.new(key: :output_dir,
+            env_name: 'XCODEBUILD_ANALYZE_OUTPUT_DIR',
+            description: 'Path to output dir',
+            optional: true,
+            type: String)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        [:ios, :mac].include?(platform)
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/xcodebuild_analyze/actions/xcodebuild_analyze_and_ensure_no_results_action.rb

@@ -0,0 +1,97 @@
+require 'fastlane'
+require_relative '../helper/xcodebuild_analyze_helper'
+require_relative '../helper/ensure_no_results_from_xcodebuild_analyze_helper'
+
+module Fastlane
+  module Actions
+    class XcodebuildAnalyzeAndEnsureNoResultsAction < Action
+      def self.run(params)
+        configuration = Helper::XcodebuildAnalyzeHelper.parse_configuration(params)
+        configuration.output = "html"
+        Helper::XcodebuildAnalyzeHelper.run_analyzer(configuration, other_action)
+        input_path = configuration.workspace ? configuration.workspace : configuration.project
+        path = "#{File.dirname(input_path)}/#{configuration.output_dir}"
+        Helper::EnsureNoResultsFromXcodebuildAnalyzeHelper.ensure_no_results(
+          path,
+          params[:prune_output]
+        )
+      end
+
+      def self.category
+        :building
+      end
+
+      def self.description
+        "Run code analyzer using xcodebuild and fail if any vulnerability is found"
+      end
+
+      def self.authors
+        ["Marcin Stepnowski"]
+      end
+
+      def self.example_code
+        [
+          "
+          xcodebuild_analyze_and_ensure_no_results(
+              project: 'Meniga.xcodeproj',
+              scheme: 'Release',
+              sdk: 'iphonesimulator'
+              output_dir: 'tmp',
+              static_analyzer: true,
+              prune_output: true)
+          "
+        ]
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :workspace,
+            env_name: "XCODEBUILD_ANALYZE_AND_ENSURE_NO_RESULTS_WORKSPACE",
+            description: "WORKSPACE Workspace (.xcworkspace) file to use to analyze app (automatically detected in current directory)",
+            optional: true,
+            type: String),
+          FastlaneCore::ConfigItem.new(key: :project,
+            env_name: "XCODEBUILD_ANALYZE_AND_ENSURE_NO_RESULTS_PROJECT",
+            description: "Project (.xcodeproj) file to use to analyze app (overridden by --workspace option, if passed)",
+            optional: true,
+            type: String),
+          FastlaneCore::ConfigItem.new(key: :configuration,
+            env_name: "XCODEBUILD_ANALYZE_AND_ENSURE_NO_RESULTS_CONFIGURATION",
+            description: "Configuration used to analyze",
+            optional: true,
+            type: String),
+          FastlaneCore::ConfigItem.new(key: :scheme,
+            env_name: "XCODEBUILD_ANALYZE_AND_ENSURE_NO_RESULTS_SCHEME",
+            description: "Scheme used to analyze app",
+            optional: false,
+            type: String),
+          FastlaneCore::ConfigItem.new(key: :sdk,
+            env_name: "XCODEBUILD_ANALYZE_AND_ENSURE_NO_RESULTS_SDK",
+            description: "Use SDK as the name or path of the base SDK when building the project",
+            optional: true,
+            type: String),
+          FastlaneCore::ConfigItem.new(key: :static_analyzer,
+            env_name: "XCODEBUILD_ANALYZE_AND_ENSURE_NO_RESULTS_STATIC_ANALYZER",
+            description: "Run clang static analyzer if true",
+            optional: true,
+            type: Boolean),
+          FastlaneCore::ConfigItem.new(key: :prune_output,
+            env_name: 'XCODEBUILD_ANALYZE_AND_ENSURE_NO_RESULTS_PRUNE_OUTPUT',
+            description: 'If true remove output dir after analyze',
+            optional: true,
+            type: Boolean),
+          FastlaneCore::ConfigItem.new(key: :output_dir,
+            env_name: 'XCODEBUILD_ANALYZE_AND_ENSURE_NO_RESULTS_OUTPUT_DIR',
+            description: 'Path to output dir',
+            default_value: 'analyze_results',
+            optional: true,
+            type: String)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        [:ios, :mac].include?(platform)
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/xcodebuild_analyze/helper/ensure_no_results_from_xcodebuild_analyze_helper.rb

@@ -0,0 +1,19 @@
+require 'fastlane'
+
+module Fastlane
+  UI = FastlaneCore::UI unless Fastlane.const_defined?("UI")
+
+  module Helper
+    class EnsureNoResultsFromXcodebuildAnalyzeHelper
+      def self.ensure_no_results(path, prune)
+        results = Dir["#{path}/**/**.html"]
+        FileUtils.rm_rf(path) if prune
+        if results.empty?
+          UI.success("Project is free of analyzer warnings, all good! 💪")
+        else
+          UI.user_error!("Analyzer found vulnerabilities in #{results.count} file(s)!")
+        end
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/xcodebuild_analyze/helper/xcodebuild_analyze_helper.rb

@@ -0,0 +1,56 @@
+require 'fastlane'
+
+class XcodebuildAnalyzeConfiguration
+  attr_accessor :workspace
+  attr_accessor :project
+  attr_accessor :scheme
+  attr_accessor :sdk
+  attr_accessor :output
+  attr_accessor :output_dir
+  attr_accessor :static_analyzer
+
+  def initialize(dictionary)
+    @workspace = dictionary[:workspace]
+    @project = dictionary[:project]
+    @scheme = dictionary[:scheme]
+    @sdk = dictionary[:sdk]
+    @output = dictionary[:output]
+    @output_dir = dictionary[:output_dir]
+    @static_analyzer = dictionary[:static_analyzer]
+  end
+end
+
+module Fastlane
+  UI = FastlaneCore::UI unless Fastlane.const_defined?("UI")
+
+  module Helper
+    class XcodebuildAnalyzeHelper
+      def self.parse_configuration(params)
+        XcodebuildAnalyzeConfiguration.new(params.values)
+      end
+
+      def self.run_analyzer(configuration, other_action)
+        workspace_path = "../#{configuration.workspace}" unless configuration.workspace.nil?
+        project_path = "../#{configuration.project}" unless configuration.project.nil?
+
+        xcargs = []
+        output = configuration.output
+        output_dir = configuration.output_dir
+        static_analyzer = configuration.static_analyzer
+        xcargs << "CLANG_ANALYZER_OTHER_FLAGS=" unless output.nil? && output_dir.nil? && static_analyzer.nil?
+        xcargs << "CLANG_ANALYZER_OUTPUT=#{output}" unless output.nil?
+        xcargs << "CLANG_ANALYZER_OUTPUT_DIR=#{output_dir}" unless output_dir.nil?
+        xcargs << "RUN_CLANG_STATIC_ANALYZER=#{static_analyzer ? 'YES' : 'NO'}" unless static_analyzer.nil?
+
+        other_action.xcodebuild(
+          workspace: workspace_path,
+          project: project_path,
+          scheme: configuration.scheme,
+          sdk: configuration.sdk,
+          analyze: true,
+          xcargs: xcargs.join(' ')
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+module Fastlane
+  module XcodebuildAnalyze
+    VERSION = "1.0.0"
+  end
+end

metadata

@@ -0,0 +1,191 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-xcodebuild_analyze
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Meniga
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-04-22 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.143.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.143.0
+- !ruby/object:Gem::Dependency
+  name: codecov
+  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: mobile.dev@meniga.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/xcodebuild_analyze.rb
+- lib/fastlane/plugin/xcodebuild_analyze/actions/ensure_no_results_from_xcodebuild_analyze_action.rb
+- lib/fastlane/plugin/xcodebuild_analyze/actions/xcodebuild_analyze_action.rb
+- lib/fastlane/plugin/xcodebuild_analyze/actions/xcodebuild_analyze_and_ensure_no_results_action.rb
+- lib/fastlane/plugin/xcodebuild_analyze/helper/ensure_no_results_from_xcodebuild_analyze_helper.rb
+- lib/fastlane/plugin/xcodebuild_analyze/helper/xcodebuild_analyze_helper.rb
+- lib/fastlane/plugin/xcodebuild_analyze/version.rb
+homepage: https://github.com/meniga/fastlane-plugin-xcodebuild_analyze
+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.6
+signing_key: 
+specification_version: 4
+summary: Run code analyzer using xcodebuild
+test_files: []