fastlane-plugin-test_center 0.5.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 40ba8db5eb5707650f3ddd74ceee5a58f1f44f5d
-  data.tar.gz: 3a3e481b05ae0b53bde7a942589449c6f0ba4aaa
+  metadata.gz: f2a4eab0e48a0368b7ed7b596ade9b9d01eb9d96
+  data.tar.gz: 2abbb33b228295a82074eeea475f25d4b5922a61
 SHA512:
-  metadata.gz: 60cd6052f5245ce7fabe12c1594d7cfe923a4016107a79a8dbc123755f89f7aa7ea123e24e75a65ef48313a1457faf37ecb35ea422263276ac007a6b3522ed65
-  data.tar.gz: 9e93b53367284accaba1e28964ffbfd6ee79fbcee6f9fc5b20706d4fc35fac19d7d6fed544e72f144d42529b5cf2511da4cc476b3e77c63132060c2785b9e6be
+  metadata.gz: d29a3717f7295a40bfa0e296e7fc66439eda6ced5eaeb1e1a6bd3111fdef48c3886daccc3f912ab82eae5944001bf432a54aa29cfa9946f479a5ffd292978802
+  data.tar.gz: ff94f2678cf27e35c0643e928c935fce5f2725d4998b978f9f2572843104ff142e7ac171759350e56434a8eaf18ea8b5cb5fb0119075fcc6f06ac82ca1f11c9d

data/README.md

@@ -12,16 +12,22 @@ fastlane add_plugin test_center
 
 ## About test_center
 
-Makes testing your iOS app easier
-
-**Note to author:** Add a more detailed description about this plugin here. If your plugin contains multiple actions, make sure to mention them here.
+This plugin makes testing your iOS app easier by providing you actions that allow
+you to run the fastlane `scan` action multiple times and retrying only failed
+tests, retrieve which tests failed during `scan`, and suppressing given tests in
+an Xcode project.
+
+This fastlane plugin includes the following actions:
+- `multi_scan`: uses scan to run Xcode tests a given number of times: only re-testing failing tests
+- `suppress_tests_from_junit`: uses a junit xml report file to suppress either passing or failing tests in an Xcode Scheme
+- `suppress_tests`: suppresses specific tests in a specific or all Xcode Schemes in a given project
+- `suppressed_tests`: retrieves a list of tests that are suppressed in a specific or all Xcode Schemes in a project
+- `tests_from_junit`: retrieves the failing and passing tests as reported in a junit xml file
 
 ## 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`.
 
-**Note to author:** Please set up a sample project to make it easy for users to explore what your plugin does. Provide everything that is necessary to try out the plugin in this project (including a sample Xcode/Android project if necessary)
-
 ## Run tests for this plugin
 
 To run both the tests, and code style validation, run

data/lib/fastlane/plugin/test_center/actions/multi_scan.rb

@@ -71,25 +71,23 @@ module Fastlane
       #####################################################
 
       def self.description
-        "A short description with <= 80 characters of what this action does"
+        "Uses scan to run Xcode tests a given number of times: only re-testing failing tests."
       end
 
       def self.details
-        # Optional:
-        # this is your chance to provide a more detailed description of this action
-        "You can use this action to do cool things..."
+        "Use this action to run your tests if you have fragile tests that fail sporadically."
       end
 
       def self.scan_options
-        ScanAction.available_options.reject { |config_item| config_item.key == :output_files }
+        ScanAction.available_options
       end
 
       def self.available_options
         scan_options + [
           FastlaneCore::ConfigItem.new(
             key: :try_count,
-            env_name: "FL_MULTI_SCAN_TRY_COUNT", # The name of the environment variable
-            description: "The number of times to retry running tests via scan", # a short description of this parameter
+            env_name: "FL_MULTI_SCAN_TRY_COUNT",
+            description: "The number of times to retry running tests via scan",
             type: Integer,
             is_string: false,
             default_value: 1
@@ -97,33 +95,11 @@ module Fastlane
         ]
       end
 
-      def self.output
-        # Define the shared values you are going to provide
-        # Example
-        [
-          ['MULTI_SCAN_CUSTOM_VALUE', 'A description of what this value contains']
-        ]
-      end
-
-      def self.return_value
-        # If your method provides a return value, you can describe here what it does
-      end
-
       def self.authors
-        # So no one will ever forget your contribution to fastlane :) You are awesome btw!
-        ["Your GitHub/Twitter Name"]
+        ["lyndsey-ferguson/@ldferguson"]
       end
 
       def self.is_supported?(platform)
-        # you can do things like
-        #
-        #  true
-        #
-        #  platform == :ios
-        #
-        #  [:ios, :mac].include?(platform)
-        #
-
         platform == :ios
       end
     end

data/lib/fastlane/plugin/test_center/actions/suppress_tests.rb

@@ -1,9 +1,5 @@
 module Fastlane
   module Actions
-    module SharedValues
-      SUPPRESS_TESTS_CUSTOM_VALUE = :SUPPRESS_TESTS_CUSTOM_VALUE
-    end
-
     class SuppressTestsAction < Action
       require 'xcodeproj'
 
@@ -38,24 +34,15 @@ module Fastlane
       #####################################################
 
       def self.description
-        "A short description with <= 80 characters of what this action does"
-      end
-
-      def self.details
-        # Optional:
-        # this is your chance to provide a more detailed description of this action
-        "You can use this action to do cool things..."
+        "Suppresses specific tests in a specific or all Xcode Schemes in a given project"
       end
 
       def self.available_options
-        # Define all options your action supports.
-
-        # Below a few examples
         [
           FastlaneCore::ConfigItem.new(
             key: :xcodeproj,
-            env_name: "FL_SUPPRESS_TESTS_XCODE_PROJECT", # The name of the environment variable
-            description: "The file path to the Xcode project file to modify", # a short description of this parameter
+            env_name: "FL_SUPPRESS_TESTS_XCODE_PROJECT",
+            description: "The file path to the Xcode project file to modify",
             verify_block: proc do |path|
               UI.user_error!("Error: Xcode project file path not given!") unless path and !path.empty?
               UI.user_error!("Error: Xcode project '#{path}' not found!") unless Dir.exist?(path)
@@ -63,8 +50,8 @@ module Fastlane
           ),
           FastlaneCore::ConfigItem.new(
             key: :tests,
-            env_name: "FL_SUPPRESS_TESTS_TESTS_TO_SUPPRESS", # The name of the environment variable
-            description: "A list of tests to suppress", # a short description of this parameter
+            env_name: "FL_SUPPRESS_TESTS_TESTS_TO_SUPPRESS",
+            description: "A list of tests to suppress",
             verify_block: proc do |tests|
               UI.user_error!("Error: no tests were given to suppress!") unless tests and !tests.empty?
               tests.each do |test_identifier|
@@ -79,8 +66,8 @@ module Fastlane
           FastlaneCore::ConfigItem.new(
             key: :scheme,
             optional: true,
-            env_name: "FL_SUPPRESS_TESTS_SCHEME_TO_UPDATE", # The name of the environment variable
-            description: "The Xcode scheme where the tests should be suppressed", # a short description of this parameter
+            env_name: "FL_SUPPRESS_TESTS_SCHEME_TO_UPDATE",
+            description: "The Xcode scheme where the tests should be suppressed",
             verify_block: proc do |scheme_name|
               UI.user_error!("Error: Xcode Scheme '#{scheme_name}' is not valid!") if scheme_name and scheme_name.empty?
             end
@@ -88,33 +75,11 @@ module Fastlane
         ]
       end
 
-      def self.output
-        # Define the shared values you are going to provide
-        # Example
-        [
-          ['SUPPRESS_TESTS_CUSTOM_VALUE', 'A description of what this value contains']
-        ]
-      end
-
-      def self.return_value
-        # If your method provides a return value, you can describe here what it does
-      end
-
       def self.authors
-        # So no one will ever forget your contribution to fastlane :) You are awesome btw!
-        ["Your GitHub/Twitter Name"]
+        ["lyndsey-ferguson/@ldferguson"]
       end
 
       def self.is_supported?(platform)
-        # you can do things like
-        #
-        #  true
-        #
-        #  platform == :ios
-        #
-        #  [:ios, :mac].include?(platform)
-        #
-
         platform == :ios
       end
     end

data/lib/fastlane/plugin/test_center/actions/suppress_tests_from_junit.rb

@@ -1,9 +1,5 @@
 module Fastlane
   module Actions
-    module SharedValues
-      SUPPRESS_TESTS_FROM_JUNIT_CUSTOM_VALUE = :SUPPRESS_TESTS_FROM_JUNIT_CUSTOM_VALUE
-    end
-
     class SuppressTestsFromJunitAction < Action
       def self.run(params)
         project_path = params[:xcodeproj]
@@ -94,16 +90,12 @@ module Fastlane
         "Uses a junit xml report file to suppress either passing or failing tests in an Xcode Scheme"
       end
 
-      def self.details
-        "To be added"
-      end
-
       def self.available_options
         [
           FastlaneCore::ConfigItem.new(
             key: :xcodeproj,
-            env_name: "FL_SUPPRESS_TESTS_FROM_JUNIT_XCODE_PROJECT", # The name of the environment variable
-            description: "The file path to the Xcode project file to modify", # a short description of this parameter
+            env_name: "FL_SUPPRESS_TESTS_FROM_JUNIT_XCODE_PROJECT",
+            description: "The file path to the Xcode project file to modify",
             verify_block: proc do |path|
               UI.user_error!("Error: Xcode project file path not given!") unless path and !path.empty?
               UI.user_error!("Error: Xcode project '#{path}' not found!") unless Dir.exist?(path)
@@ -111,7 +103,7 @@ module Fastlane
           ),
           FastlaneCore::ConfigItem.new(
             key: :junit,
-            env_name: "FL_SUPPRESS_TESTS_FROM_JUNIT_JUNIT_REPORT", # The name of the environment variable
+            env_name: "FL_SUPPRESS_TESTS_FROM_JUNIT_JUNIT_REPORT",
             description: "The junit xml report file from which to collect the tests to suppress",
             verify_block: proc do |path|
               UI.user_error!("Error: cannot find the junit xml report file '#{path}'") unless File.exist?(path)
@@ -120,8 +112,8 @@ module Fastlane
           FastlaneCore::ConfigItem.new(
             key: :scheme,
             optional: true,
-            env_name: "FL_SUPPRESS_TESTS_FROM_JUNIT_SCHEME_TO_UPDATE", # The name of the environment variable
-            description: "The Xcode scheme where the tests should be suppressed", # a short description of this parameter
+            env_name: "FL_SUPPRESS_TESTS_FROM_JUNIT_SCHEME_TO_UPDATE",
+            description: "The Xcode scheme where the tests should be suppressed",
             verify_block: proc do |scheme_name|
               UI.user_error!("Error: Xcode Scheme '#{scheme_name}' is not valid!") if scheme_name and scheme_name.empty?
             end
@@ -129,8 +121,8 @@ module Fastlane
           FastlaneCore::ConfigItem.new(
             key: :suppress_type,
             type: Symbol,
-            env_name: "FL_SUPPRESS_TESTS_FROM_JUNIT_SUPPRESS_TYPE", # The name of the environment variable
-            description: "Tests to suppress are either :failed or :passing", # a short description of this parameter
+            env_name: "FL_SUPPRESS_TESTS_FROM_JUNIT_SUPPRESS_TYPE",
+            description: "Tests to suppress are either :failed or :passing",
             verify_block: proc do |type|
               UI.user_error!("Error: suppress type ':#{type}' is invalid! Only :failed or :passing are valid types") unless %i[failed passing].include?(type)
             end

data/lib/fastlane/plugin/test_center/actions/suppressed_tests.rb

@@ -1,9 +1,5 @@
 module Fastlane
   module Actions
-    module SharedValues
-      SUPPRESSED_TESTS_CUSTOM_VALUE = :SUPPRESSED_TESTS_CUSTOM_VALUE
-    end
-
     class SuppressedTestsAction < Action
       require 'set'
 
@@ -34,24 +30,15 @@ module Fastlane
       #####################################################
 
       def self.description
-        "A short description with <= 80 characters of what this action does"
-      end
-
-      def self.details
-        # Optional:
-        # this is your chance to provide a more detailed description of this action
-        "You can use this action to do cool things..."
+        "Retrieves a list of tests that are suppressed in a specific or all Xcode Schemes in a project"
       end
 
       def self.available_options
-        # Define all options your action supports.
-
-        # Below a few examples
         [
           FastlaneCore::ConfigItem.new(
             key: :xcodeproj,
-            env_name: "FL_SUPPRESSED_TESTS_XCODE_PROJECT", # The name of the environment variable
-            description: "The file path to the Xcode project file to read the skipped tests from", # a short description of this parameter
+            env_name: "FL_SUPPRESSED_TESTS_XCODE_PROJECT",
+            description: "The file path to the Xcode project file to read the skipped tests from",
             verify_block: proc do |path|
               UI.user_error!("Error: Xcode project file path not given!") unless path and !path.empty?
               UI.user_error!("Error: Xcode project '#{path}' not found!") unless Dir.exist?(path)
@@ -60,8 +47,8 @@ module Fastlane
           FastlaneCore::ConfigItem.new(
             key: :scheme,
             optional: true,
-            env_name: "FL_SUPPRESSED_TESTS_SCHEME_TO_UPDATE", # The name of the environment variable
-            description: "The Xcode scheme where the suppressed tests may be", # a short description of this parameter
+            env_name: "FL_SUPPRESSED_TESTS_SCHEME_TO_UPDATE",
+            description: "The Xcode scheme where the suppressed tests may be",
             verify_block: proc do |scheme_name|
               UI.user_error!("Error: Xcode Scheme '#{scheme_name}' is not valid!") if scheme_name and scheme_name.empty?
             end
@@ -69,33 +56,11 @@ module Fastlane
         ]
       end
 
-      def self.output
-        # Define the shared values you are going to provide
-        # Example
-        [
-          ['SUPPRESSED_TESTS_CUSTOM_VALUE', 'A description of what this value contains']
-        ]
-      end
-
-      def self.return_value
-        # If your method provides a return value, you can describe here what it does
-      end
-
       def self.authors
-        # So no one will ever forget your contribution to fastlane :) You are awesome btw!
-        ["Your GitHub/Twitter Name"]
+        ["lyndsey-ferguson/@ldferguson"]
       end
 
       def self.is_supported?(platform)
-        # you can do things like
-        #
-        #  true
-        #
-        #  platform == :ios
-        #
-        #  [:ios, :mac].include?(platform)
-        #
-
         platform == :ios
       end
     end

data/lib/fastlane/plugin/test_center/actions/tests_from_junit.rb

@@ -44,7 +44,7 @@ module Fastlane
       #####################################################
 
       def self.description
-        "Get the failing and passing tests as reported in a junit xml file"
+        "Retrieves the failing and passing tests as reported in a junit xml file"
       end
 
       def self.available_options

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

@@ -1,5 +1,5 @@
 module Fastlane
   module TestCenter
-    VERSION = "0.5.0"
+    VERSION = "1.0.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-test_center
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Lyndsey Ferguson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-15 00:00:00.000000000 Z
+date: 2017-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -122,7 +122,13 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description: |2
+      This fastlane plugin includes the following actions:
+      - multi_scan: uses scan to run Xcode tests a given number of times: only re-testing failing tests
+      - suppress_tests_from_junit: uses a junit xml report file to suppress either passing or failing tests in an Xcode Scheme
+      - suppress_tests: suppresses specific tests in a specific or all Xcode Schemes in a given project
+      - suppressed_tests: retrieves a list of tests that are suppressed in a specific or all Xcode Schemes in a project
+      - tests_from_junit: retrieves the failing and passing tests as reported in a junit xml file
 email: lyndsey.ferguson@appian.com
 executables: []
 extensions: []
@@ -135,7 +141,6 @@ files:
 - lib/fastlane/plugin/test_center/actions/suppress_tests.rb
 - lib/fastlane/plugin/test_center/actions/suppress_tests_from_junit.rb
 - lib/fastlane/plugin/test_center/actions/suppressed_tests.rb
-- lib/fastlane/plugin/test_center/actions/test_center_action.rb
 - lib/fastlane/plugin/test_center/actions/tests_from_junit.rb
 - lib/fastlane/plugin/test_center/helper/test_center_helper.rb
 - lib/fastlane/plugin/test_center/version.rb
@@ -164,4 +169,3 @@ signing_key:
 specification_version: 4
 summary: Makes testing your iOS app easier
 test_files: []
-has_rdoc: 

data/lib/fastlane/plugin/test_center/actions/test_center_action.rb

@@ -1,44 +0,0 @@
-module Fastlane
-  module Actions
-    class TestCenterAction < Action
-      def self.run(params)
-        UI.message("The test_center plugin is working!")
-      end
-
-      def self.description
-        "Makes testing your iOS app easier"
-      end
-
-      def self.authors
-        ["Lyndsey Ferguson"]
-      end
-
-      def self.return_value
-        # If your method provides a return value, you can describe here what it does
-      end
-
-      def self.details
-        # Optional:
-        "Makes testing your iOS app easier by providing a list of possible tests, changing what tests are suppressed or not, re-running fragile tests, etc."
-      end
-
-      def self.available_options
-        [
-          # FastlaneCore::ConfigItem.new(key: :your_option,
-          #                         env_name: "TEST_CENTER_YOUR_OPTION",
-          #                      description: "A description of your option",
-          #                         optional: false,
-          #                             type: String)
-        ]
-      end
-
-      def self.is_supported?(platform)
-        # Adjust this if your plugin only works for a particular platform (iOS vs. Android, for example)
-        # See: https://github.com/fastlane/fastlane/blob/master/fastlane/docs/Platforms.md
-        #
-        # [:ios, :mac, :android].include?(platform)
-        true
-      end
-    end
-  end
-end