You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Mar 13, 2025. It is now read-only.
| MONGODB_URI | The MongoDB URI. This needs to be the same MongoDB used by topcoder-x-receiver, topcoder-x-processor, and topcoder-x-site | mongodb://127.0.0.1:27017/topcoderx |
10
9
|TOPIC | The Kafka topic where events are published. This must be the same as the configured value for topcoder-x-processor||
11
10
|KAFKA_OPTIONS | Kafka connection options||
12
-
|KAFKA_HOST| The Kafka host to connect to| localhost:9092 |
11
+
|KAFKA_URL| The Kafka host to connect to| localhost:9092 |
13
12
|KAFKA_CLIENT_CERT | The Kafka SSL certificate to use when connecting| Read from kafka_client.cer file, but this can be set as a string like it is on Heroku |
14
13
|KAFKA_CLIENT_CERT_KEY | The Kafka SSL certificate key to use when connecting| Read from kafka_client.key file, but this can be set as a string like it is on Heroku|
15
14
|TC_DEV_ENV| the flag whether to use topcoder development api or production| false|
16
-
| TC_AUTHN_URL | the Topcoder authentication url |https://topcoder-dev.auth0.com/oauth/ro|
17
-
| TC_AUTHN_REQUEST_BODY | the Topcoder authentication request body. This makes use of some environment variables: `TC_USERNAME`, `TC_PASSWORD`, `TC_CLIENT_ID`, `CLIENT_V2CONNECTION`| see `default.js`|
18
-
| TC_AUTHZ_URL | the Topcoder authorization url |https://api.topcoder-dev.com/v3/authorizations|
19
15
| NEW_CHALLENGE_TEMPLATE | the body template for new challenge request. You can change the subTrack, reviewTypes, technologies, .. here | see `default.js`|
20
16
| NEW_CHALLENGE_DURATION_IN_DAYS | the duration of new challenge | 5 |
21
17
| NODE_MAILER_OPTIONS| the node mailer smtp options, see [here](https://nodemailer.com/smtp/ for more detail)| see `default.js`|
@@ -31,7 +27,18 @@ The following config parameters are supported, they are defined in `config/defau
31
27
|RETRY_COUNT| the number of times an event should be retried to process| 3|
32
28
|RETRY_INTERVAL| the interval at which the event should be retried to process in milliseconds | 120000|
33
29
|READY_FOR_REVIEW_ISSUE_LABEL| the label name for ready for review, should be one of the label configured in topcoder x ui|'tcx_ReadyForReview'|
30
+
|NOT_READY_ISSUE_LABEL| the label name for not ready, should be one of the label configured in topcoder x ui|'tcx_NotReady'|
31
+
|CANCELED_ISSUE_LABEL| the label name for canceled, should be one of the label configured in topcoder x ui|'tcx_Canceled'|
34
32
|CANCEL_CHALLENGE_INTERVAL| the time in millisecond after which the challenge will be closed| '24*60*60*1000'|
33
+
|AWS_ACCESS_KEY_ID | The Amazon certificate key to use when connecting. Use local dynamodb you can set fake value|FAKE_ACCESS_KEY_ID |
34
+
|AWS_SECRET_ACCESS_KEY | The Amazon certificate access key to use when connecting. Use local dynamodb you can set fake value|FAKE_SECRET_ACCESS_KEY |
35
+
|AWS_REGION | The Amazon certificate region to use when connecting. Use local dynamodb you can set fake value|FAKE_REGION |
36
+
|IS_LOCAL | Use Amazon DynamoDB Local or server. |'false' |
37
+
|AUTH0_URL| The Auth0 URL for generating Machine-to-machine token |https://topcoder-dev.auth0.com/oauth/token|
38
+
|AUTH0_AUDIENCE| The audience of Auth0 to generate M2M Token |https://m2m.topcoder-dev.com/|
39
+
|TOKEN_CACHE_TIME| The machine-to-machine token cache validation time |43200|
40
+
|AUTH0_CLIENT_ID| The Auth0 ClientID for generating Machine-to-machine token ||
41
+
|AUTH0_CLIENT_SECRET| The Auth0 Client Secret for generating Machine-to-machine token ||
35
42
36
43
KAFKA_OPTIONS should be object as described in https://github.com/oleksiyk/kafka#ssl
37
44
For using with SSL, the options should be as
@@ -47,20 +54,21 @@ For using with SSL, the options should be as
47
54
48
55
The following config paramaters are supported in the test environment defined in `config/test.js` and can be configured in the system environment. Note that the test config inherits all config options present in the default config and adds/overrides some config options.
| TC_URL | the topcoder development url |https://www.topcoder-dev.com|
53
-
| TC_DEV_API_URL | the topcoder development api url |https://api.topcoder-dev.com/v3|
54
-
| MAX_RETRY_COUNT | the maximum number of times to re-test before concluding that test failed |https://api.topcoder-dev.com/v3|
55
-
| WAIT_TIME | the amount of time in milliseconds to wait before running a re-test | 30000 |
56
-
| TC_DIRECT_ID | the topcoder direct id of the repository which is set up with a valid billing account | 7377 |
57
-
| TOPCODER_USER_NAME | a valid username for topcoder dev platform | mess |
58
-
| HOOK_BASE_URL | the webhook url of topcoder-x-receiver ||
59
-
| GITHUB_ACCESS_TOKEN | github personal access token ||
60
-
| GITHUB_REPOSITORY_NAME | the name of the repository to create for testing (should not already exist) ||
61
-
| GITLAB_USERNAME | gitlab username ||
62
-
| GITLAB_PASSWORD | gitlab password ||
63
-
| GITLAB_REPOSITORY_NAME | the name of the repository to create for testing (should not already exist) ||
57
+
| Name | Description | Default |
58
+
|:--|:--|:--|
59
+
| TC_URL | the topcoder development url |https://www.topcoder-dev.com|
60
+
| TC_DEV_API_URL | the topcoder development api url |https://api.topcoder-dev.com/v3|
61
+
| MAX_RETRY_COUNT | the maximum number of times to re-test before concluding that test failed | 17 |
62
+
| WAIT_TIME | the amount of time in milliseconds to wait before running a re-test | 60000 |
63
+
| TC_DIRECT_ID | the topcoder direct id of the repository which is set up with a valid billing account | 7377 |
64
+
| TOPCODER_USER_NAME | a valid username for topcoder dev platform | mess |
65
+
| HOOK_BASE_URL | the webhook url of topcoder-x-receiver ||
66
+
| GITHUB_ACCESS_TOKEN | github personal access token ||
67
+
| GITHUB_REPOSITORY_NAME | the name of the repository to create for testing (should not already exist) ||
68
+
| GITLAB_USERNAME | gitlab username ||
69
+
| GITLAB_PASSWORD | gitlab password ||
70
+
| GITLAB_REPOSITORY_NAME | the name of the repository to create for testing (should already exist) ||
71
+
| GITLAB_REPO_URL | the URL of the repository to create for testing (should already exist) ||
64
72
65
73
## Github Verification
66
74
@@ -71,7 +79,7 @@ Configure a Github project with a webhook with a format like this: https://<rece
71
79
#### Smoke test
72
80
- Create an issue in the repo, you can see the logs in `receiver`, the `issue.created` event is generated. You should then see the processor receive the event and process it accordingly. It's important to validate that the issue.created event is seen by the receiver *and* the processor. This ensures that the Kafka communication between the two services is working properly.
73
81
74
-
You can test other events, but just validating that an issue.created event is generated in Kafka is enough to smoke test the receiver is set up properly.
82
+
You can test other events, but just validating that an issue.created event is generated in Kafka is enough to smoke test the receiver is set up properly.
0 commit comments