open-duelyst/duelyst

[P1] Repair and enable disabled integration tests

Open

#48 opened on Sep 24, 2022

View on GitHub
 (2 comments) (0 reactions) (0 assignees)JavaScript (3,443 stars) (526 forks)batch import
backendenhancementhelp wanted

Description

As of #47, we are running integration tests in Github Actions. However, we are only running a subset of the available tests. We should repair the following tests and enable them in .github/workflows/integration_tests.yaml:

yarn test:integration:data_access: All of these tests are failing due to misuse of Knex in the Users module:

  14) users module
       "before all" hook in "users module":
     TypeError: knex(...).where(...).first(...).bind is not a function
    at Function.UsersModule.createNewUser (server/lib/data_access/users.coffee:138:4)

yarn test:integration:firebase: In order to run Firebase tests, we need to create a Firebase Realtime Database which can be used by Github Actions.

There are also tests which are commented out and need to be reworked, either because they were broken or because they were too slow:

% git grep -l 'Test disabled'
test/integration/achievements/collector_supreme.js
test/integration/achievements/home_turf.js
test/integration/achievements/seven_sisters.js
test/integration/data_access/cosmetic_chests.js
test/integration/data_access/inventory.js
test/integration/data_access/migrations.js
test/integration/data_access/rift.js
test/integration/data_access/users.js

Contributor guide

Tech stack
javascriptnodejsfirebasegithub actions
Domain
testingbackend
Issue type
test
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Knowledge of KnexKnowledge of FirebaseFamiliarity with GitHub Actions
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
The issue lists broken integration tests in `test/integration/data access/users.js` (Knex misuse in `server/lib/data access/users.coffee:138`), Firebase integration tests needing a database setup, and several tests commented out with 'Test disabled'. To start, review `.github/workflows/integration tests.yaml` to see current test jobs, then fix the Knex binding error in the users module. For Firebase tests, research how to create a Firebase Realtime Database for CI. For the disabled tests, uncomment and rework them as needed, checking the referenced files like `test/integration/achievements/collector supreme.js` and others. Check issue comments for any additional context.