Flank Github action

Action

This Github action allow running Flank using your Github workflows.

Documentation for Flank is at flank.github.io/flank

Usage

Inputs

Input name	Description	Required	Default
version	Flank version to run. Minimal supported version is v21.03.1. Leaving it blank will fallback to latest version.	false	latest available
service_account	Service account to authenticate with. Could be path to file, link to file or file content itself. More information about creating a service account could be found at documentation	true
platform	Platform to run. Could be ios or android	true
flank_configuration_file	Flank configuration file. More info how it should look like is in documentation	true

Outputs

Output name	Description
gcloud_results_directory	Link to Gcloud store where results are stored.
local_results_directory	Path to local results directory. All output files from this run are stored inside. You could use it as output artifacts.

Adding to workflows

- name: <your name>
  id: <id of action>
  uses: Flank/flank@master
  with:
    version: <Flank version to run, minimum supported is v21.03.1, default latest>
    service_account: <file content, file link or path to file with service account> 
    platform: [android|ios]
    flank_configuration_file: <Path to configuration file>

Example workflows

Service account file content from secrets

- name: flank run
  id: flank_run
  uses: Flank/flank@master
  with:
    # Flank version to run
    version: v21.03.1
    # Service account file content from secrets
    service_account: ${{ secrets.SERVICE_ACCOUNT }} 
    # Run Android tests
    platform: android
    # Path to configuration file from local repo
    flank_configuration_file: './testing/android/flank-simple-success.yml'

- name: output
  run: |
    # Use local directory output
    echo "Local directory: ${{ steps.flank_run.outputs.local_results_directory }}"
    # Use Gcloud storage output 
    echo "Gcloud: ${{ steps.flank_run.outputs.gcloud_results_directory }}"

Service account file from repository

- name: flank run
  id: flank_run
  uses: Flank/flank@master
  with:
    # Service account file from repository
    service_account: './service_account.json'
    # Run Android tests
    platform: android
    # Path to configuration file from local repo
    flank_configuration_file: './testing/android/flank-simple-success.yml'

- name: output
  run: |
    # Use local directory output
    echo "Local directory: ${{ steps.flank_run.outputs.local_results_directory }}"
    # Use Gcloud storage output 
    echo "Gcloud: ${{ steps.flank_run.outputs.gcloud_results_directory }}"

Create service account during workflow

- name: Create service account
  run: echo '${{ secrets.SERVICE_ACCOUNT }}' > service_account_created.json

- name: flank run
  id: flank_run
  uses: Flank/flank@master
  with:
    # Service account created in previous step
    service_account: './service_account_created.json'
    # Run Android tests
    platform: android
    # Path to configuration file from local repo
    flank_configuration_file: './testing/android/flank-simple-success.yml'

- name: output
  run: |
    # Use local directory output
    echo "Local directory: ${{ steps.flank_run.outputs.local_results_directory }}"
    # Use Gcloud storage output 
    echo "Gcloud: ${{ steps.flank_run.outputs.gcloud_results_directory }}"

Runner OS support

All 3 runner operating systems are supported.

Flank Scripts 1.9.2

refactor: Clean up dependencies (#1696)

PR removes a couple of unused dependencies

## Test Plan
> How do we know the code works?

Both build and IT run finish without any error

Flank v21.03.1

v21.03.1

Bug Fixes

• #1680 Fix output report error with dump shards (pawelpasterz)
• #1671 Saving service account by flank script (adamfilipow92)
• #1662 Fix NPE in GcToolResults (pawelpasterz)
• #1657 Remove physical device from integration tests (adamfilipow92)
• #1656 Snapshot publish by disabling closing staging artifacts (piotradamczyk5)
• #1652 Fix snapshot upload (piotradamczyk5)
• #1649 JUnitReport.xml only contained 50 test results (dmytrodanylyk)
• #1648 Publishing to GithubPackages (piotradamczyk5)

Features

• #1675 Return directories path in Flank Github action (adamfilipow92, piotradamczyk5)
• #1673 Run Flank Github action with config provided by user (adamfilipow92, piotradamczyk5)
• #1663 Added reading service account in Github action (adamfilipow92, piotradamczyk5)
• #1660 Add Flank GitHub action (adamfilipow92, piotradamczyk5)
• #1659 Remove flank-actions (Sloox)
• #1655 Update Flank Slack release notifier (Sloox)

CI Changes

• #1679 Fix publishing snapshots (piotradamczyk5)
• #1654 Treat env json as a string (pawelpasterz)
• #1653 Parse env object to JSON (pawelpasterz)
• #1639 Update workflow file (pawelpasterz)

Documentation

• #1621 Corellium sandbox (pawelpasterz)
• #1670 Add SDD for 1609 feature request (pawelpasterz)
• #1644 Add Flank output research docs (adamfilipow92, piotradamczyk5)

Tests update

• #1661 Implement logic to clear LocalGcs after each test (pawelpasterz)

Refactor

• #1651 Change packages of commands (piotradamczyk5)

Flank Scripts 1.9.1

fix: Saving service account by flank script (#1671)

Fixes #

## Test Plan
> How do we know the code works?

When ```./config/gcloud``` path does not exist flank scripts should create directories.

Flank Scripts 1.9.0

feat: Added reading service account in Github action (#1663)

Fixes #1597

## Test Plan
> How do we know the code works?

### Flank scripts part
Run command
- `flankScripts firebase save_service_account --account=<file content, link, file path>` -> to test storing service account

### Github action part
You could run Flank GitHub action on [testing repository](https://github.com/Flank/flank-github-action-testing/actions)

## Checklist

- [x] Documented
- [x] Unit tested
- [x] Test repository updated

Flank Scripts 1.8.0

flank-scripts-1.8.0

feat: Add Flank GitHub action (#1660)

Flank Scripts 1.7.3

flank-scripts-1.7.3

ci: Update workflow file (#1639)

Flank v21.03.0

v21.03.0

Bug Fixes

• #1647 Reading PGP key in env (piotradamczyk5)
• #1646 Publishing to maven central by running commands one by one (piotradamczyk5)
• #1645 Release job (piotradamczyk5)
• #1631 Update compare files in IT (Sloox, pawelpasterz)
• #1628 Remove analytics from integration tests (Sloox)
• #1626 Spacing fix for yml file (Sloox)
• #1620 Authenticate in Github CLI before release Flank-Scripts (piotradamczyk5)
• #1619 Releasing flank-scripts (piotradamczyk5)
• #1617 Release job (piotradamczyk5)
• #1612 NPE on dumpShards (adamfilipow92)
• #1593 Remove GameloopIT test for IOS (Sloox)
• #1585 Print Flank version only on run command (adamfilipow92)
• #1581 Fixes for Workflow files & IT tests (Sloox, adamfilipow92)
• #1575 Increase heap size (pawelpasterz)
• #1564 Windows issues (Sloox)
• #1560 Fix IT workflow for windows (Sloox)
• #1557 Move shards json to result directory (adamfilipow92, piotradamczyk5)

CI Changes

• #1641 Add missing subcommands (pawelpasterz)
• #1642 Fix release workflow (pawelpasterz)
• #1640 Fix gradle command (pawelpasterz)
• #1618 Publish Flank-scripts to Github (piotradamczyk5)
• #1614 Publish flank to maven central (adamfilipow92, piotradamczyk5)

Documentation

• #1627 Explore test-targets-for-shards SDD (Sloox, piotradamczyk5)
• #1592 Fix SDD for Github action (piotradamczyk5)
• #1590 Github action SDD proposal (piotradamczyk5)
• #1583 Flank-scripts ops package organization (piotradamczyk5)
• #1566 Flank-scripts command overview (piotradamczyk5)

Features

• #1635 Part 2 of IT tests (Sloox, pawelpasterz)
• #1624 Part 1 of multiple OS IT tests (Sloox)
• #1559 Add storing output as json (adamfilipow92, piotradamczyk5)

Refactor

• #1589 Move function to files which use them (adamfilipow92, piotradamczyk5)
• #1584 Reorganize domain layer of flank scripts (adamfilipow92, piotradamczyk5)
• #1574 Refactor CLI of Flank-scripts (piotradamczyk5)
• #1572 Flank scripts features not depends on each other (adamfilipow92)
• #1533 Refactor flank scripts (jan-gogo, adamfilipow92, piotradamczyk5)

Flank Scripts 1.7.2

ci: Add missing subcommands (#1641)

Adds missing `NextTagCommand` and `GenerateReleaseNotesCommand` to the `release` command

Flank Scripts 1.7.1

build: Dependencies updates [2021-03-01] (#1636)

Dependencies updates