Skip to content
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.

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

migrate tests from bats to bun #2

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
.env
compose.yml
Dockerfile
**/node_modules/
175 changes: 175 additions & 0 deletions tests/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,175 @@
# Based on https://raw.githubusercontent.com/github/gitignore/main/Node.gitignore

# Logs

logs
_.log
npm-debug.log_
yarn-debug.log*
yarn-error.log*
lerna-debug.log*
.pnpm-debug.log*

# Caches

.cache

# Diagnostic reports (https://nodejs.org/api/report.html)

report.[0-9]_.[0-9]_.[0-9]_.[0-9]_.json

# Runtime data

pids
_.pid
_.seed
*.pid.lock

# Directory for instrumented libs generated by jscoverage/JSCover

lib-cov

# Coverage directory used by tools like istanbul

coverage
*.lcov

# nyc test coverage

.nyc_output

# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)

.grunt

# Bower dependency directory (https://bower.io/)

bower_components

# node-waf configuration

.lock-wscript

# Compiled binary addons (https://nodejs.org/api/addons.html)

build/Release

# Dependency directories

node_modules/
jspm_packages/

# Snowpack dependency directory (https://snowpack.dev/)

web_modules/

# TypeScript cache

*.tsbuildinfo

# Optional npm cache directory

.npm

# Optional eslint cache

.eslintcache

# Optional stylelint cache

.stylelintcache

# Microbundle cache

.rpt2_cache/
.rts2_cache_cjs/
.rts2_cache_es/
.rts2_cache_umd/

# Optional REPL history

.node_repl_history

# Output of 'npm pack'

*.tgz

# Yarn Integrity file

.yarn-integrity

# dotenv environment variable files

.env
.env.development.local
.env.test.local
.env.production.local
.env.local

# parcel-bundler cache (https://parceljs.org/)

.parcel-cache

# Next.js build output

.next
out

# Nuxt.js build / generate output

.nuxt
dist

# Gatsby files

# Comment in the public line in if your project uses Gatsby and not Next.js

# https://nextjs.org/blog/next-9-1#public-directory-support

# public

# vuepress build output

.vuepress/dist

# vuepress v2.x temp and cache directory

.temp

# Docusaurus cache and generated files

.docusaurus

# Serverless directories

.serverless/

# FuseBox cache

.fusebox/

# DynamoDB Local files

.dynamodb/

# TernJS port file

.tern-port

# Stores VSCode versions used for testing VSCode extensions

.vscode-test

# yarn v2

.yarn/cache
.yarn/unplugged
.yarn/build-state.yml
.yarn/install-state.gz
.pnp.*

# IntelliJ based IDEs
.idea

# Finder (MacOS) folder config
.DS_Store
15 changes: 15 additions & 0 deletions tests/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# deployment-tests

To install dependencies:

```bash
bun install
```

To run:

```bash
bun run index.ts
```

This project was created using `bun init` in bun v1.1.0. [Bun](https://bun.sh) is a fast all-in-one JavaScript runtime.
Binary file added tests/bun.lockb
Binary file not shown.
76 changes: 76 additions & 0 deletions tests/docker_test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
import { $ } from "bun";
import { beforeAll, describe, expect, it } from "bun:test";

import { assertEnvironmentVariableNotEmpty, findLastVersion } from "./helpers";

const { env } = process;

describe("Compose", () => {
beforeAll(() => {
assertEnvironmentVariableNotEmpty(["ROCKETCHAT_TAG", "COMPOSE_FILE"]);
});

it("should be a valid compose file", async () => {
const { stderr, exitCode } =
await $`docker compose -f ${process.env.COMPOSE_FILE} config -q`
.nothrow()
.quiet();

if (exitCode) {
console.error(stderr.toString())
}

expect(exitCode).toBe(0);
});

it("should deploy fine with an empty .env", async () => {
// const project_name = basename(env.PWD as string)
// .replaceAll(".", "")
// .toLowerCase();

const structure =
await $`docker compose -f ${env.COMPOSE_FILE} config --format json`.json();

const expected = {
mongodb: {
MONGODB_ADVERTISED_HOSTNAME: "mongodb",
MONGODB_INITIAL_PRIMARY_HOST: "mongodb",
MONGODB_INITIAL_PRIMARY_PORT_NUMBER: "27017",
},
rocketchat: {
MONGO_URL: "mongodb://mongodb:27017/rocketchat?replicaSet=rs0",
ROOT_URL: "http://localhost:3000",
},
};

const assertVariable = (service: string, variable: string, value: string) =>
expect(structure.services[service].environment[variable]).toBe(value);

Object.entries(expected).map(([service, environment]) =>
Object.entries(environment).map(([variable, value]) =>
assertVariable(service, variable, value)
)
);
});

it("should generate the right config after modifying environment variables", async () => {
const _env = {
PORT: 3001,
BIND_IP: "127.0.0.1",
HOST_PORT: 80,
MONGODB_REPLICA_SET_NAME: "rocket_rs0",
MONGODB_PORT_NUMBER: 27018,
MONGODB_INITIAL_PRIMARY_PORT_NUMBER: 27018,
RELEASE: env.ROCKETCHAT_TAG,
};

let envStr = "";
Object.entries(_env).map(
([variable, value]) => (envStr += `${variable}=${value}\n`)
);

await $`echo ${envStr} > .env`;

console.log(await findLastVersion())
});
});
32 changes: 32 additions & 0 deletions tests/helpers.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
import { expect } from "bun:test";
import { Octokit } from "octokit";

export function assertEnvironmentVariableNotEmpty(variables: string[]) {
variables.forEach((variable) => expect(variable).not.toBeUndefined());
}

async function* _releases() {
let page = 1;
while (true) {
yield new Octokit({}).rest.repos.listReleases({
owner: "RocketChat",
repo: "Rocket.Chat",
page: page,
});
page++;
}
}

// @ts-ignore-error
export async function findLastVersion(): Promise<string> {
let next = false;
for await (const release of _releases()) {
if (release.data.tag_name == process.env.ROCKETCHAT_TAG) {
next = true;
}

if (next && !release.data.prerelease) {
return release.data.tag_name;
}
}
}
1 change: 1 addition & 0 deletions tests/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
console.log("Hello via Bun!");
14 changes: 14 additions & 0 deletions tests/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"name": "deployment-tests",
"module": "index.ts",
"type": "module",
"devDependencies": {
"@types/bun": "^1.2.0"
},
"peerDependencies": {
"typescript": "^5.0.0"
},
"dependencies": {
"octokit": "^4.1.0"
}
}
27 changes: 27 additions & 0 deletions tests/tsconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
{
"compilerOptions": {
// Enable latest features
"lib": ["ESNext", "DOM"],
"target": "ESNext",
"module": "ESNext",
"moduleDetection": "force",
"jsx": "react-jsx",
"allowJs": true,

// Bundler mode
"moduleResolution": "bundler",
"allowImportingTsExtensions": true,
"verbatimModuleSyntax": true,
"noEmit": true,

// Best practices
"strict": true,
"skipLibCheck": true,
"noFallthroughCasesInSwitch": true,

// Some stricter flags (disabled by default)
"noUnusedLocals": false,
"noUnusedParameters": false,
"noPropertyAccessFromIndexSignature": false
}
}