RocketChat / RocketChat/Rocket.Chat.js.SDK

Rocket.Chat CI container for SDK tests

Open
#8 7 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
146
Forks
99
Avg merge
7h 59m
Merged PRs (30d)
17

Description

SDK tests require a parallel instance of Rocket.Chat (provisioned by the utils/setup.ts script) to run test interactions.

Currently it can only pass tests in local development, because it requires a manually provisioned instance to be running on localhost. Would be best if it can be scripted to create it's own temporary docker instance of Rocket.Chat, so tests can run in the CI environment.

The instance would need a default admin user/pass, then the test setup utils can use the API to create/edit/remove any other users or rooms required before/after each test.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the existing utils/setup.ts script and trace how SDK tests currently expect a locally provisioned Rocket.Chat instance. Define the CI flow for creating a temporary Docker instance with default admin credentials, allowing setup to manage test users and rooms, and cleaning it up afterward. Done means the SDK interaction tests run in CI without manual localhost provisioning.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker, typescript
Domain
ci-cd, devops, testing
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.