# Appsurify Script Installation
## Index
- [Installation Instructions](#install)
- [Available Arguments](#available_arguments)
- [Required Arguments](#required_arguments)
- [Recommended Arguments](#recommended_arguments)
- [Tests To Run](#teststorun)
- [Example Usage](#example_usage)
- [Additional Arguments](#additional_arguments)
- [Build Failure Arguments](#build_failure_arguments)
## <a id="install"></a>Installation Instructions
### Requirements
Python 3.6+
### Installation Command
pip install appsurifyci --upgrade
## <a id="available_arguments"></a>Available Arguments
### <a id="required_arguments"></a>Required Arguments
| argument | options |
| --- | --- |
| apikey | Apikey from appsurify |
| url | Url of the appsurify instance i.e. "https://dummy.appsurify.com"|
| project | Name of the project |
| testsuite | Name of the testsuite |
| branch | Name of the branch the tests are running against |
| commit | SHA of the commit |
### <a id="recommended_arguments"></a>Recommended Arguments
| argument | options |
| --- | --- |
| runtemplate | Options - all tests, no tests (used just to push results from the prior command), prioritized tests (requires --percentage argument to be added and the percentage of tests to be run. See [below](#teststorun) for details |
| testtemplate | Options - mvn, cucumber mvn, sahi testrunner, sahi ant, testim, mocha, pytest, rspec, robotframework, cyprus, mstest, vstest, katalon, opentest. For additional integrations talk to the Appsurify team |
| runcommand | Command to execute tests in the target environment, if command is custom to your test suite |
| report | Location of xml reports created by the test run if this is not the default location for the test type |
## <a id="teststorun"></a>Parameter Details - Tests Execution
| Option | Details |
| --- | --- |
| all tests | Will run all tests. Will fail on any failure. Recommended for nightly or weekly test executions |
| no tests | Will run no tests. Will fail on any failure. Recommended when starting with Appsurify to just upload data |
| prioritized tests | Requires the percentage argument. Will only fail the build on new/reopened defects. Recommended for your most frequent run type |
## <a id="example_usage"></a>Example Usage
runtestswithappsurify --url "https://dummy.appsurify.com" --apikey "$APIKEY" --project "$PROJECT" --testsuite "$TESTSUITE" --runtemplate "prioritized tests" --testtemplate "mvn" --percentage "20" --commit "$COMMIT" --branch "$BRANCH"
## <a id="additional_arguments"></a>Additional Arguments - For Customization
| argument | default | options/details |
| --- | --- | --- |
| fail | newdefects, reopeneddefects | options newdefects, reopeneddefects, flakybrokentests, newflaky, reopenedflaky, failedtests, brokentests |
| rerun | "false" | whether failed tests should be rerun |
| maxrerun | 3 | the number of times failed tests should be rerun |
| failfast | "false" | whether after each set of test runs to determine if the build has failed (tests will still be rerun if this has been selected) |
| executioncommand | "" | Command to be executed following completion of the script [[teststorun]] will be replaced with the formatted list of tests to run |
| percentage | "" | Percentage of tests to be run if prioritized tests is selected in the runtemplate |
For CI specific integrations please contact Appsurify
Change Log
==========
0.0.83
-------------------
- multi repo to running tests
0.0.76
-------------------
- multi repo to git script
0.0.72
-------------------
- retries and timeouts for requests
0.0.67
-------------------
- Additional logging for git
0.0.66
-------------------
- Split for xunit azure
- Latest as option for commits
0.0.62
-------------------
- Add support for Gradle cucumber and playwright
0.0.56
-------------------
- Add Git script
0.0.33
-------------------
- Improve azure functionality
- Set tests to run for variable on failure
0.0.31
-------------------
- Add ability to run new tests
- Add ability to run all tests on weekend
0.0.26
-------------------
- Add new runcommand param
- Add percentage
0.0.25
-------------------
- Fix for invalid trx files
0.0.23
-------------------
- Fix for webdriver io creating invalud Junit
- Fix for large trx files
- Improvement for specflow removing retry
0.0.22
-------------------
- Include additional filter for Azure
0.0.21
-------------------
- Change report to work for partial paths in Windows
0.0.19
-------------------
- Update for Cypress
0.0.18
-------------------
- Added recursive search for reports
0.0.17
-------------------
- Add integration with Bitrise using --bitrise flag saves tests to env variable TESTS_TO_RUN
0.0.16
-------------------
- Update for pipe output
0.0.12
-------------------
- Update for pipe output
0.0.9
-------------------
- Update for trainer
0.0.7 (08/02/2021)
-------------------
- Update for Azure to run tests via saved variable
0.0.5 (08/02/2021)
-------------------
- Default rerun to false
0.0.4 (08/02/2021)
-------------------
- Add try catch to environment variable creation
0.0.3 (08/02/2021)
-------------------
- Third Release
- Fix failfast tests
0.0.2 (07/02/2021)
-------------------
- Second Release
0.0.1 (07/02/2021)
-------------------
- First Release
Raw data
{
"_id": null,
"home_page": "https://appsurify.com",
"name": "appsurifyci",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "appsurify",
"author": "James Farrier",
"author_email": "jamesfarrier@appsurify.com",
"download_url": "https://files.pythonhosted.org/packages/ce/11/067b17dc2a2f1a5d7b0c168d1483efbc21fbeb0bf1ae8524462272228459/appsurifyci-0.1.51.tar.gz",
"platform": null,
"description": "# Appsurify Script Installation\r\n\r\n## Index\r\n- [Installation Instructions](#install)\r\n- [Available Arguments](#available_arguments)\r\n - [Required Arguments](#required_arguments)\r\n - [Recommended Arguments](#recommended_arguments)\r\n- [Tests To Run](#teststorun)\r\n- [Example Usage](#example_usage)\r\n- [Additional Arguments](#additional_arguments)\r\n - [Build Failure Arguments](#build_failure_arguments)\r\n\r\n\r\n## <a id=\"install\"></a>Installation Instructions\r\n\r\n### Requirements\r\n\r\nPython 3.6+\r\n\r\n### Installation Command\r\n\r\npip install appsurifyci --upgrade\r\n\r\n## <a id=\"available_arguments\"></a>Available Arguments\r\n \r\n### <a id=\"required_arguments\"></a>Required Arguments \r\n\r\n| argument | options |\r\n| --- | --- |\r\n| apikey | Apikey from appsurify |\r\n| url | Url of the appsurify instance i.e. \"https://dummy.appsurify.com\"|\r\n| project | Name of the project |\r\n| testsuite | Name of the testsuite |\r\n| branch | Name of the branch the tests are running against |\r\n| commit | SHA of the commit |\r\n\r\n### <a id=\"recommended_arguments\"></a>Recommended Arguments\r\n| argument | options |\r\n| --- | --- |\r\n| runtemplate | Options - all tests, no tests (used just to push results from the prior command), prioritized tests (requires --percentage argument to be added and the percentage of tests to be run. See [below](#teststorun) for details |\r\n| testtemplate | Options - mvn, cucumber mvn, sahi testrunner, sahi ant, testim, mocha, pytest, rspec, robotframework, cyprus, mstest, vstest, katalon, opentest. For additional integrations talk to the Appsurify team |\r\n| runcommand | Command to execute tests in the target environment, if command is custom to your test suite |\r\n| report | Location of xml reports created by the test run if this is not the default location for the test type |\r\n\r\n\r\n## <a id=\"teststorun\"></a>Parameter Details - Tests Execution \r\n\r\n| Option | Details |\r\n| --- | --- |\r\n| all tests | Will run all tests. Will fail on any failure. Recommended for nightly or weekly test executions |\r\n| no tests | Will run no tests. Will fail on any failure. Recommended when starting with Appsurify to just upload data |\r\n| prioritized tests | Requires the percentage argument. Will only fail the build on new/reopened defects. Recommended for your most frequent run type |\r\n\r\n\r\n## <a id=\"example_usage\"></a>Example Usage\r\n\r\nruntestswithappsurify --url \"https://dummy.appsurify.com\" --apikey \"$APIKEY\" --project \"$PROJECT\" --testsuite \"$TESTSUITE\" --runtemplate \"prioritized tests\" --testtemplate \"mvn\" --percentage \"20\" --commit \"$COMMIT\" --branch \"$BRANCH\"\r\n\r\n## <a id=\"additional_arguments\"></a>Additional Arguments - For Customization\r\n\r\n| argument | default | options/details |\r\n| --- | --- | --- |\r\n| fail | newdefects, reopeneddefects | options newdefects, reopeneddefects, flakybrokentests, newflaky, reopenedflaky, failedtests, brokentests |\r\n| rerun | \"false\" | whether failed tests should be rerun |\r\n| maxrerun | 3 | the number of times failed tests should be rerun |\r\n| failfast | \"false\" | whether after each set of test runs to determine if the build has failed (tests will still be rerun if this has been selected) |\r\n| executioncommand | \"\" | Command to be executed following completion of the script [[teststorun]] will be replaced with the formatted list of tests to run |\r\n| percentage | \"\" | Percentage of tests to be run if prioritized tests is selected in the runtemplate |\r\n\r\nFor CI specific integrations please contact Appsurify\r\n\r\n\r\nChange Log\r\n==========\r\n0.0.83\r\n-------------------\r\n- multi repo to running tests\r\n\r\n0.0.76\r\n-------------------\r\n- multi repo to git script\r\n\r\n0.0.72\r\n-------------------\r\n- retries and timeouts for requests\r\n\r\n0.0.67\r\n-------------------\r\n- Additional logging for git\r\n\r\n0.0.66\r\n-------------------\r\n- Split for xunit azure\r\n- Latest as option for commits\r\n\r\n0.0.62\r\n-------------------\r\n- Add support for Gradle cucumber and playwright\r\n\r\n0.0.56\r\n-------------------\r\n- Add Git script\r\n\r\n0.0.33\r\n-------------------\r\n- Improve azure functionality\r\n- Set tests to run for variable on failure\r\n\r\n0.0.31\r\n-------------------\r\n- Add ability to run new tests\r\n- Add ability to run all tests on weekend\r\n\r\n\r\n0.0.26\r\n-------------------\r\n- Add new runcommand param\r\n- Add percentage\r\n\r\n\r\n0.0.25\r\n-------------------\r\n- Fix for invalid trx files\r\n\r\n0.0.23\r\n-------------------\r\n- Fix for webdriver io creating invalud Junit\r\n- Fix for large trx files\r\n- Improvement for specflow removing retry\r\n\r\n0.0.22\r\n-------------------\r\n- Include additional filter for Azure\r\n\r\n0.0.21\r\n-------------------\r\n- Change report to work for partial paths in Windows\r\n\r\n0.0.19\r\n-------------------\r\n- Update for Cypress\r\n\r\n\r\n0.0.18\r\n-------------------\r\n- Added recursive search for reports\r\n\r\n0.0.17\r\n-------------------\r\n- Add integration with Bitrise using --bitrise flag saves tests to env variable TESTS_TO_RUN\r\n\r\n0.0.16\r\n-------------------\r\n- Update for pipe output\r\n\r\n0.0.12\r\n-------------------\r\n- Update for pipe output\r\n\r\n0.0.9\r\n-------------------\r\n- Update for trainer\r\n\r\n0.0.7 (08/02/2021)\r\n-------------------\r\n- Update for Azure to run tests via saved variable\r\n\r\n0.0.5 (08/02/2021)\r\n-------------------\r\n- Default rerun to false\r\n\r\n0.0.4 (08/02/2021)\r\n-------------------\r\n- Add try catch to environment variable creation\r\n\r\n0.0.3 (08/02/2021)\r\n-------------------\r\n- Third Release\r\n- Fix failfast tests\r\n\r\n0.0.2 (07/02/2021)\r\n-------------------\r\n- Second Release\r\n\r\n0.0.1 (07/02/2021)\r\n-------------------\r\n- First Release\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Package used to run tests using Appsurify",
"version": "0.1.51",
"project_urls": {
"Homepage": "https://appsurify.com"
},
"split_keywords": [
"appsurify"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ce11067b17dc2a2f1a5d7b0c168d1483efbc21fbeb0bf1ae8524462272228459",
"md5": "14e93e181c7dc30db34ef41e9c071c24",
"sha256": "a570890f575b46bcd72aac3801ebfe3d3e963eefd6dfc9206bec67f94c63be15"
},
"downloads": -1,
"filename": "appsurifyci-0.1.51.tar.gz",
"has_sig": false,
"md5_digest": "14e93e181c7dc30db34ef41e9c071c24",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 100998,
"upload_time": "2024-10-05T06:14:27",
"upload_time_iso_8601": "2024-10-05T06:14:27.335554Z",
"url": "https://files.pythonhosted.org/packages/ce/11/067b17dc2a2f1a5d7b0c168d1483efbc21fbeb0bf1ae8524462272228459/appsurifyci-0.1.51.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-05 06:14:27",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "appsurifyci"
}
JSON