Skip to content

Refactor test suite and clean up unused elements #264

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
davenquinn merged 13 commits into from
Nov 20, 2025
Merged

Refactor test suite and clean up unused elements #264

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
ce73534
Removed some unused dependencies
davenquinn Nov 19, 2025
4621928
Got API tests running again
davenquinn Nov 19, 2025
4246d3b
Most API tests work
davenquinn Nov 19, 2025
93b2158
API tests pass except for small differences with production
davenquinn Nov 19, 2025
f335711
Simplified test loading
davenquinn Nov 19, 2025
369c5ad
Updated tests to use env variables for configuration
davenquinn Nov 19, 2025
bb6e3f2
Updated database connection management for non-ssl connections
davenquinn Nov 19, 2025
4577bb5
Improved API testing
davenquinn Nov 20, 2025
11dab12
Updated credential handling more
davenquinn Nov 20, 2025
e2fb0b9
Strip old database defs
davenquinn Nov 20, 2025
b530e2b
Completely remove Universal Analytics
davenquinn Nov 20, 2025
a317471
Remove legacy code
davenquinn Nov 20, 2025
e3af857
Upgraded yarn
davenquinn Nov 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
664 changes: 329 additions & 335 deletions .yarn/releases/yarn-4.9.1.cjs → .yarn/releases/yarn-4.11.0.cjs
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion .yarnrc.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
yarnPath: .yarn/releases/yarn-4.9.1.cjs
yarnPath: .yarn/releases/yarn-4.11.0.cjs
34 changes: 21 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,11 @@ Redis is optional. When the API starts requests for all columns and all units
are cached. If Redis is available it will be used, otherwise they are cached in
the application memory.

The API requires `node` v14 or later to run. Recent testing has been conducted
on `node` v18.
The API requires `node` v20 or to run.

#### Data
## Data

The following databases must be in place:

- MariaDB - macrostrat
- Postgres - burwell, alice, wof, elevation
The `macrostrat` PostgreSQL database must be available.

## Setup

Expand All @@ -42,12 +38,6 @@ Next, install dependencies:
yarn install
```

NOTE: Postgres connections are completely broken in node v14 and v15 (as of
2021-03-16). Use node v12!

This will also run the script `postinstall.sh` which copies credentials files
into place.

## Running the API

Add environment variables to your shell or `.env` file. The
Expand All @@ -56,6 +46,17 @@ Add environment variables to your shell or `.env` file. The
To start the API run `npm start <port|5000>`. This will start the API on the
specified port (default 5000).

## Running tests

Tests can be run with `yarn test`. Currently, you must have a local instance of the
API running separately (e.g., `yarn start` or `yarn run dev`). You can also set
the `TEST_API_URL` variable to a different URL if you want to test a
different instance.

Additionally, you can set a `TEST_PRODUCTION_API_URL` to run comparisons against
another running instance of the API (e.g., production). This is useful for
ensuring that new versions of the API return the same results as older versions.

## Generating a release

Update the version string in `package.json` and run:
Expand All @@ -74,6 +75,13 @@ instructions for generating a cache refresh key. The cache refresh key is used
as a secret parameter to programmatically refresh the column cache, such as in
situations in which the underlying data has been changed (editing, adding, etc).

## Data

Required databases (version 1):

- MariaDB - macrostrat
- Postgres - burwell, alice, wof, elevation

## Running

To start the API simply run `npm start` which will start a process on port 5050.
Expand Down
3 changes: 0 additions & 3 deletions api-tests/Makefile
View file
Open in desktop

This file was deleted.

Loading