step.yml

title: "Shard XCode Test Target"
summary: "Shard XCode Test Target into multiple equal sized XCode Test Plans"
description: |-
  # Bitrise Test Plan Sharder step

  This step can be used to automatically create equal sized XCode Test Plans from a XCode Test Target.

  This step will modify your XCode Project & XCode Scheme to add the generated Test Plans.

  These Test Plans can then be run in parallel in fan out builds.

  ## Prerequisites

  - NodeJS - https://nodejs.org/en/download/

  To verify your NodeJS Installation run:

  `node -v`

  You should see something like this printed if it was successful:

   `v12.13.0`

  ## Run Step Locally

  To run this step locally you will need to set the inputs using Enviroment Variables

  **Enviroment Variables**

  ```
  export SOURCE_DIR="/User/var/git/ios"
  export XCODE_PROJECT="Notes.xcodeproj"
  export SHARDS=2
  export TARGET="Notes"
  export SCHEME="NotesUITests"
  export DEBUG="false"
  ```

  **Running**

  From the folder you downloaded this code open the terminal and run:

  `node index.js` 

  **Note:** This will modify your XCode Project & XCode Scheme to add the newly created Test Plans.

  ## Input variables

  **Path to XCode Project** (required)
    * **Description:** This is the location of your xcode project
    * **Example:** `$BITRISE_SOURCE_DIR/ios`

  **XCode Project** (required)
    * **Description:** XCode Project name
    * **Example:** `Notes.xcodeproj`

  **XCode Target** (required)
    * **Description:** The XCode Target to create Test Plans from
    * **Example:** `NotesUITests`

  **XCode Test Plan name** (optional)
    * **Description:** The XCode Test Plan already in your project you want to shard. The file should be referenced relative to the XCode Project Path setting
    * **Example:** `Notes.xctestplan`

  **XCode Scheme** (required)
    * **Description:** The XCode Scheme to test
    * **Example:** `Notes`

  **How many Test Plans to create (required)**
    * **Description:** The number of Test Plans to generate
    * **Example:** `2`

  **Debug**
    * **Description:** Create verbose debug logs
    * **Example:** YES / NO
    
  **Parallelizable**
    * **Description:** Allow shards to run tests with multiple simulators in parallel
    * **Example:** YES / NO

  ## Outputs

  **TEST_PLANS**
    * **Description:** List of Test Plans Created
    * **Example:** `"TestShard_1.xctestplan","TestShard_2.xctestplan"`

website: https://github.com/DamienBitrise/bitrise-test-plan-sharder
source_code_url: https://github.com/DamienBitrise/bitrise-test-plan-sharder
support_url: https://github.com/DamienBitrise/bitrise-test-plan-sharder/issues
host_os_tags:
  - osx-10.10
  - ubuntu-16.04
type_tags:
  - test
  
project_type_tags:
  - ios

is_always_run: false
is_skippable: false

inputs:
  - path_to_xcode: $BITRISE_SOURCE_DIR
    opts:
      title: Path to xcode project no trailing slash
      summary: Location of your XCode Project
      description: This is the location and name of your xcode project
      is_required: true
      is_sensitive: false
  - xcode_project:
    opts:
      title: XCode Project
      summary: XCode Project name
      description: This is the name of your xcode project
      is_required: true
      is_sensitive: false
  - target:
    opts:
      title: XCode Target or Test Plan name
      summary: The XCode Target or Test Plans to shard
      description: The XCode Target or Test Plan will be used to create shards
      is_required: true
      is_sensitive: false
  - test_path:
    opts:
      title: Path where your test target tests are located
      summary: The path to the test cases in the file system
      description: All your test target test class files should be in this folder
      is_required: false
      is_sensitive: false
  - test_plan:
    opts:
      title: (Optional) XCode Test Plan name
      summary: The XCode Test Plans to shard if you do not have test plans enabled leave this blank. Note You will need to replace the existing test plan with the test plan shard in your fan out builds. eg. cp TestShard_0.xctestplan Notes.xctestplan
      description: The XCode Test Plan will be used to create shards if one is specified
      is_required: false
      is_sensitive: false
  - scheme:
    opts:
      title: XCode Scheme
      summary: The XCode Scheme to test
      description: The Test Plans will be added to this XCode Scheme
      is_required: true
      is_sensitive: false
  - shards:
    opts:
      title: How many Test Plans to create
      summary: The number of Test Plans to generate
      description: This will create Test Plans containing equal numbers of test cases
      is_required: true
      is_sensitive: false
  - debug_mode: "false"
    opts: 
      category: Debug
      title: "Enable Debug Mode"
      summary: The step will print more verbose logs if enabled.
      description: The step will print more verbose logs if enabled.
      is_required: true
      is_sensitive: false
      value_options:
        - "false"
        - "true"
  - parallelizable: "false"
    opts:
      title: "Enable Simulator Parallelization"
      summary: Each shard will run its tests in parallel if enabled.
      description: Each shard will run its tests in parallel if enabled.
      is_required: true
      is_sensitive: false
      value_options:
        - "false"
        - "true"
outputs:
  - TEST_PLANS:
    opts:
      title: List of Test Plans Created
      summary: List of Test Plans Created
      description: List of Test Plans Created