https://github.com/natura-cosmeticos/nat-test-commons

https://github.com/natura-cosmeticos/nat-test-commons

Last synced: about 5 hours ago
JSON representation

• Host: GitHub
• URL: https://github.com/natura-cosmeticos/nat-test-commons
• Owner: natura-cosmeticos
• License: isc
• Created: 2020-06-23T21:43:13.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2022-06-26T09:48:47.000Z (over 2 years ago)
• Last Synced: 2023-03-02T06:31:30.817Z (over 1 year ago)
• Language: Kotlin
• Size: 83 KB
• Stars: 0
• Watchers: 34
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Nat Test Commons Android

![release](https://img.shields.io/github/v/tag/natura-cosmeticos/Nat-Test-Commons?color=F4AB34&style=for-the-badge)

### What for

Library with helper functions designed to speed up the test-creating process.

### Documentation

Example usages can be found in [our Wiki](https://github.com/natura-cosmeticos/Nat-Test-Commons/wiki). If you want to generate the documentation on your own run the following command:

    make documentation

The Markdown files will be available at `$BUILD_DIR/dokka/testcommons/`

## How to contribute

You can contribute submitting [pull requests](https://github.com/natura-cosmeticos/Nat-Test-Commons/pulls).

**Pull Request Best Practices**

- If your Pull Request adds a new behavior or changes an existing one, you must update the documentation, following the instructions [here](#documentation).

- If your change needs to generate a new release of this library, change the version as described in the session [below](#how-to-create-a-new-version).

### How to create a new version

In the file **publish.gradle** update field in the method **getVersionName** with the new version number. Example, for the version 1.0.1:

    def getVersionName = { ->

        return "1.0.1"

    }

## How to use

Copy and paste the **github_credentials.properties.sample** file and rename it to **github_credentials.properties**. Updating the fields **github.username** and **github.password**. For getting your GitHub password see the [Tutorial](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line). Its important to check **read:packages** when generating you password.

**Important:** The **github_credentials.properties** file can not be committed.

In the build.gradle file, insert the following:

    repositories {

        maven {

            name = "nat-test-commons"

            url = uri("https://maven.pkg.github.com/natura-cosmeticos/Nat-Test-Commons")

            credentials {

                username = githubProperties['github.username'] ?: System.getenv("GITHUB_USERNAME")

                password = githubProperties['github.password'] ?: System.getenv("GITHUB_API_KEY")

            }

        }    

    }

And:

    dependencies {

        androidTestImplementation "com.natura.android:testcommons:"

        testImplementation "com.natura.android:testcommons:"    

    }