• Nodejs 8 is required
• Apache Kafka
• MongoDB 3.4

npm install

eslint is used to lint the javascript source code:

npm run lint

The following config parameters are supported, they are defined in config/default.js and can be configured in system environment:

KAFKA_OPTIONS should be object as described in https://github.com/oleksiyk/kafka#ssl For using with SSL, the options should be as

 {
    connectionString: '<server>',
    ssl: {
      cert: '<certificate>', 
      key:  '<key>'
    }
 }

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.

| Name | Description | Default | | :----------------------------- | :----------------------------------------: | :------------------------------: | | | TC_URL | the topcoder development url | https://www.topcoder-dev.com | | TC_DEV_API_URL | the topcoder development api url | https://api.topcoder-dev.com/v3| | MAX_RETRY_COUNT | the maximum number of times to re-test before concluding that test failed | https://api.topcoder-dev.com/v3| | WAIT_TIME | the amount of time in milliseconds to wait before running a re-test | 30000 | | TC_DIRECT_ID | the topcoder direct id of the repository which is set up with a valid billing account | 7377 | | TOPCODER_USER_NAME | a valid username for topcoder dev platform | mess | | HOOK_BASE_URL | the webhook url of topcoder-x-receiver | | | GITHUB_ACCESS_TOKEN | github personal access token | | | GITHUB_REPOSITORY_NAME | the name of the repository to create for testing (should not already exist) | | | GITLAB_USERNAME | gitlab username | | | GITLAB_PASSWORD | gitlab password | | | GITLAB_REPOSITORY_NAME | the name of the repository to create for testing (should not already exist) | |

npm start

Before verifying the tool, 3 service needs be configured and run them

• processor
• receiver
• Topcoder X

Go to Topcoder X UI login with above used topcoder username and

• go to settings and make sure git hosts are correctly setup, if not click setup and authorize to setup.

• Go to Topcoder X UI and go to project management and add a project from git account and click save, and edit the same project and click 'Add Webhooks' button, verify that webhooks are set up correctly on git host's project.

Now, receiver service can receive the webhooks from git host's project and processor can processes the requests. Now you can verify this service by following the verification steps below

Configure the Github access tokens, Gitlab username and password in config/test.js.

To create a Github personal access token, click on Settings -> Developer settings -> Personal access tokens -> Generate new token -> Provide all permissions.

Configure gitlab username and password.

Now provide repository names which do not already exist.

You can then run both github and gitlab tests by using

npm test

npm run test:github

npm run test:gitlab

• create an issue in the repo, you can see the logs in receiver and processor, the issue.created event is generated.
• update an issue in the repo, you can see the logs in receiver and processor, the issue.updated event is generated.
• create a comment on an issue, you can see the logs in receiver and processor, the comment.created event is generated.
• update a comment on an issue, you can see the logs in receiver and processor, the comment.updated event is generated.
• assigned a user to an issue, you can see the logs in receiver and processor, the issue.assigned event is generated.
• unassigned a user to an issue, you can see the logs in receiver and processor, the issue.unassigned event is generated.
• add or remove a label to an issue, you can see the logs in receiver and processor, the issue.labelUpdated event is generated.
• create a pull request, you can see the logs in receiver and processor, the pull_request.created event is generated.
• close a pull request without merge, you can see the logs in receiver and processor, the pull_request.closed event is generated and the merged property is false.
• merge a pull request, you can see the logs in receiver and processor, the pull_request.closed event is generated and the merged property is true.
• close an issue in the repo, you can see the logs in receiver and processor, the issue.closed event is generated

• Create a new issue in the repo. E.g.
  • With the title: [$20] A new issue title
  • With the body (Markdown supported):

    ## A new issue body header
    
    A new issue body content with ***bold*** text and a [link](https://github.com/ngoctay/Luettich-test/issues/).
    

• You will see a new project created in the logs if project for that repository is not created already. E.g.

  debug: new project created with id 11916 for issue 3
  

• Then a new challenge created in the logs. E.g.

  debug: new challenge created with id 30051089 for issue 3
  

• Wait a minute or 2 for Topcoder internal systems to process the new challenge. You may get an error page HTTP Status 404 if the internal processing haven't completed yet.
• Visit challenge url to verify the challenge:

  https://www.topcoder-dev.com/challenge-details/30051089/?type=develop&noncache=true
  

  NOTE: change 30051089 to the your challenge id created in the previous step

• Update title of the issue above. E.g.

  • With the title: [$50] A new issue title - Updated the prize

• Wait a minute or 2

• Visit the challenge url to verify the updated prize and title

• Update the body of the issue. E.g.

  ## A new issue body header - Updated
  
  A new issue body content with ***bold*** text and a [link](https://github.com/ngoctay/Luettich-test/issues/). Updated
  

• Wait a minute or 2

• Visit the challenge url to verify the updated body

• Now try to update the title by adding a space after $50: [$50 ] A new issue title - Updated the prize

• The event will be ignored by processor:

  debug: nothing changed for issue 3
  

• Update the title by removing [$50 ], you'll get an error:

  error:  Error: Cannot parse prize from title: A new issue title - Updated the prize
  

• Add/update comment to bid or accept the bid
• To bid on the issue, comment as /bid $50. Minimum one space is need between /bid and $ sign. This will trigger comment.created or comment.updated event based on comment create/edit.
• if comment is bid then an email is sent to the user configured in ISSUE_BID_EMAIL_RECEIVER in config file
• To accept bid on the issue, comment as /accept_bid @username $50
• if comment is accepting bid then
  • title of issue will be changed with accepted bid amount
  • issue will be assigned to user username if not already assigned

When an user is assigned to an issue then 'issue.assigned' event will be captured and processed as

• processor will get the Topcoder handle for such user using Ragnar self service tool api
• if user is found then the topcoder challenge associated with that issue will be updated as
  • topcoder user will be assigned
• if user is not found in mapping
  • comment on github/gitlab issue will added as :

  @username, please sign-up with Topcoder x Self-service tool.
  

  • user will be unassigned from issue

When an issue is closed it will first check if issue has any assignee or not,

• if there is no assignee then simply ignores the issue closed event with message in logger
• if there is an assignee then it will
  • first set the current assignee user as challenge assignee,
  • activate the challenge with project's billing
  • closes the challenge with winner as assignee
  • you can verify the challenge closed in OR (link will be commented in same issue in git host)
  • issue label will be updated from configured paid and fix accepted label name
• if there is no fix_accepted label or prize is zero then the challenge will cancelled

You can see following logs

debug: Looking up TC handle of git user: 82332
debug: Getting the billing account ID for project ID: 15180
debug: Getting project billing detail 15180
debug: assigning the billing account id 70016668 to challenge
debug: Updating challenge 30052019 with {"billingAccountId":70016668,"prizes":[234]}
debug: Getting the topcoder member ID for member name: tonyj
debug: Getting the topcoder member ID for copilot name : tonyj
debug: adding resource to challenge 30052019
debug: resource is added to challenge 30052019 successfully.
debug: adding resource to challenge 30052019
debug: Activating challenge 30052019
debug: Challenge 30052019 is activated successfully.
debug: close challenge with winner tonyj(8547899)
debug: Closing challenge 30052019
debug: Challenge 30052019 is closed successfully.
debug: update issue as paid
debug: Gitlab/Github issue is updated for as paid and fix accepted for 59

• if issue have already paid label it won't process