README.md

Further documentation is forthcoming.

Dev usage

Make sure you installed everything here correclty, along with the others subsystems per instructions at https://github.com/turbo-src/turbo-src.

Install

Clone

git clone https://github.com/turbo-src/service

Config

You'll need a .config.json file in the root directory of turbosrc-service.

1. A Github API Token

See here.

2. Create YOUR_SECRET

It can be anything, as long as no one can guess it.

3. Create YOUR_ENCRYPTED_TOKEN

To create YOUR_ENCRYPTED_TOKEN, install jwt_hash_encrypt and run the command below (edit with your info).

node jwt_hash_decrypt.js --secret=YOUR_SECRET --string='{"githubToken": "ghp..."}'

4. Create turbosrc-service/.config.json

• Replace YOUR_USERNAME with your Github username
• Replace YOUR_SECRET with your secret to sign the token
• Replace YOUR_ENCRYPTED_TOKEN with the JWT string from 'step 2' above

{
    "github": {
        "organization": "turbo-src",
        "user": "YOUR_USERNAME",
        "apiToken": "YOUR_ENCRYPTED_TOKEN"
    },
    "turbosrc": {
        "endpoint": {
          "mode": "online",
           "url": "http://localhost:4000/graphql"
        },
        "jwt": "YOUR_SECRET",
        "store": {
            "repo": {
                "addr": "REPO_ADDR",
                "key": "REPO_KEY"
            },
            "contributor": {
                "addr": "YOUR_ADDR",
                "key": "YOUR_KEY"
            }
        }
    },
    "offchain": {
        "endpoint": {
          "mode": "online",
          "url": "http://localhost:4002/graphql"
        }
    },
    "namespace": {
        "endpoint": {
          "mode": "online",
          "url": "http://localhost:4003/graphql"
        }
    },
    "gh": {
        "endpoint": {
          "mode": "online",
          "url": "http://localhost:4004/graphql"
        }
    },
    "testers": {
        "a": {
          "user": "tsrctester1",
          "key": "TEST_KEY_1",
	      "apiToken": "ENCRYPTED_TOKEN_1"
        },
        "b": {
          "user": "tsrctester2",
          "key": "TEST_KEY_2",
	      "apiToken": "ENCRYPTED_TOKEN_2"
        },
        "c": {
          "user": "tsrctester3",
          "key": "TEST_KEY_3",
	      "apiToken": "ENCRYPTED_TOKEN_3"
        },
        "d": {
          "user": "tsrctester4",
          "key": "TEST_KEY_4",
	      "apiToken": "ENCRYPTED_TOKEN_4"
        },
        "e": {
          "user": "tsrctester5",
          "key": "TEST_KEY_5",
	      "apiToken": "ENCRYPTED_TOKEN_5"
        },
        "f": {
          "user": "tsrctester6",
          "key": "TEST_KEY_6",
	      "apiToken": "ENCRYPTED_TOKEN_6"
        },
        "g": {
          "user": "tsrctester7",
          "key": "TEST_KEY_7",
	      "apiToken": "ENCRYPTED_TOKEN_7"
        },
        "h": {
          "user": "tsrctester8",
          "key": "TEST_KEY_8",
	      "apiToken": "ENCRYPTED_TOKEN_8"
        },
        "i": {
          "user": "tsrctester9",
          "key": "TEST_KEY_9",
	      "apiToken": "ENCRYPTED_TOKEN_9"
        },
        "j": {
          "user": "tsrctester10",
          "key": "TEST_KEY_10",
	      "apiToken": "ENCRYPTED_TOKEN_10"
        },
        "k": {
          "user": "tsrctester11",
          "key": "TEST_KEY_11",
	      "apiToken": "ENCRYPTED_TOKEN_11"
        },
        "l": {
          "user": "tsrctester12",
          "key": "TEST_KEY_12",
	      "apiToken": "ENCRYPTED_TOKEN_12"
        }
    }
}

Install dependencies using Node v12.22.0

npm install

How to install and use Node v12.22.0 with NVM:

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.37.2/install.sh | bash

Close and reopen terminal:

nvm install v12.22.0

nvm use v12.22.0

Start Turbosrc.

./tsrc-dev start

Stop turbosrc.

./tsrc-dev stop

Restart turbosrc.

./tsrc-dev restart

Test turbosrc

./tsrc-dev test <username> <repository> execute_all

Example usage with user "7db9a" and repo "demo". Essentially, just replace your username and keep everything as is for basic usage.

./tsrc-dev test 7db9a demo execute_all

username is your GH personal username name. repository is the repo forked from turbo-src for testing.

More on tests with tsrc-dev

tsrc-dev test is a subcommand.

Build test environment and run all tests.

./tsrc-dev test <username> <repository> execute_all

There are various other commands with tsrc-dev test. For further usage just enter tsrc-dev test.

Here is a sample below for more granular control over testing.

./tsrc-dev test <username> <repository> delete_fork

./tsrc-dev test <username> <repository> fork_repo

./tsrc-dev test <username> <repository> create_pull_request

./tsrc-dev test <username> <repository> run_tests