stepwise-migrations 1.0.17 → 1.0.19

package/.github/workflows/test.yml

@@ -0,0 +1,34 @@
+# This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests across different versions of node
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-nodejs
+
+name: Node.js CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [18.x, 20.x, 22.x, 23.x]
+        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Run docker-compose
+        uses: hoverkraft-tech/compose-action@v2.0.1
+        with:
+          compose-file: "./docker-compose.yml"
+
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: npm ci
+      - run: npm run build
+      - run: npm test

package/README.md

@@ -1,18 +1,48 @@
 # Stepwise Migrations
 
-[![npm version](https://badge.fury.io/js/stepwise-migrations.svg?icon=si%3Anpm&)](https://badge.fury.io/js/stepwise-migrations)
-
-A tool for managing Raw SQL migrations in a Postgres database.
+A JavaScript CLI tool for managing Raw SQL migrations in a Postgres database.
 Loosely based on flyway.
 
+[![npm version](https://badge.fury.io/js/stepwise-migrations.svg?icon=si%3Anpm&)](https://badge.fury.io/js/stepwise-migrations)
+![test workflow](https://github.com/github/docs/actions/workflows/test.yml/badge.svg)
+
+## Table of Contents
+
+- [Stepwise Migrations](#stepwise-migrations)
+  - [Instructions](#instructions)
+  - [Usage](#usage)
+  - [Examples](#examples)
+    - [Migrate](#migrate)
+    - [Undo](#undo)
+    - [Validate](#validate)
+    - [Audit](#audit)
+    - [Info](#info)
+    - [Get Applied Script](#get-applied-script)
+    - [Drop](#drop)
+
 ## Instructions
 
-Up migrations are first sorted in ascending order based on filename.
-No subdirectories are read below the migration directory.
+There are three types of migrations:
+
+<b>Versioned migrations</b>
+
+- The filename must end with `.sql`.
+- These are always applied in ascending order based on filename.
+- Once applied, the file cannot be altered or else an error will be thrown.
+
+<b>Repeatable migrations</b>
+
+- Are identified by the filename ending with `.repeatable.sql`
+- For things like trigger functions
+- Are always applied after all versioned migrations
+- When altered, the new script is applied on next migration run
+
+<b>Undo migrations</b>
 
-Name the "up" migration files as `.sql` and the "down" migration files with the same name but suffixed with `.undo.sql`.
-e.g. `v1_users.sql` and `v1_users.undo.sql`.
-Down migrations are optional.
+- Run on the "undo" command
+- Can only be run on versioned migrations
+- Are applied in reverse order of the versioned migrations
+- Must have the same filename as the versioned migration but suffixed with `.undo.sql`
 
 ## Usage
 
@@ -40,7 +70,7 @@ Options:
   --schema <schema>          The schema to use for the migrations
   --path <path>              The path to the migrations directory
   --ssl true/false           Whether to use SSL for the connection (default: false)
-  --napply                      Number of up migrations to apply (default: all)
+  --napply                   Number of up migrations to apply (default: all)
   --nundo                    Number of undo migrations to apply (default: 1)
   --filename                 The filename to get the script for (default: last applied migration)
 

package/dist/test/index.test.js

@@ -110,7 +110,7 @@ node_test_1.describe.only("invalid migrations", () => __awaiter(void 0, void 0,
             recursive: true,
         });
     }));
-    node_test_1.it.only("missing undo migration", () => __awaiter(void 0, void 0, void 0, function* () {
+    (0, node_test_1.it)("missing undo migration", () => __awaiter(void 0, void 0, void 0, function* () {
         (0, utils_1.assertIncludesAll)(yield executeCommand("migrate", paths.invalid), [
             "All done!",
         ]);
@@ -126,4 +126,11 @@ node_test_1.describe.only("invalid migrations", () => __awaiter(void 0, void 0,
             "Versioned migration v1_first.sql has been altered. Cannot migrate in current state.",
         ]);
     }));
+    node_test_1.it.only("bad creds", () => __awaiter(void 0, void 0, void 0, function* () {
+        (0, utils_1.assertIncludesAll)(yield (0, utils_1.execute)(`npm exec stepwise-migrations info -- \\
+      --connection=postgresql://postgres:badpassword@127.0.0.1:5432/mydb \\
+      --schema=${schema} \\
+      --path=${paths.invalid}
+    `), ["password authentication failed for user"]);
+    }));
 }));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "stepwise-migrations",
-  "version": "1.0.17",
+  "version": "1.0.19",
   "description": "",
   "main": "./dist/src/index.js",
   "scripts": {

package/src/utils.ts

@@ -14,26 +14,33 @@ Usage: stepwise-migrations [command] [options]
 Commands:
   migrate
     Migrate the database to the latest version
-  down
+  undo
     Rollback the database to the previous version
+  validate
+    Validate the migration files and the stepwise_migration_events table
+  audit
+    Show the audit history for the migrations in the database
   info
     Show information about the current state of the migrations in the database
   drop
-    Drop the tables, schema and migration history table
+    Drop all tables, schema and stepwise_migration_events table
+  get-applied-script
+    Get the script for the last applied migration
 
 Options:
   --connection <connection>  The connection string to use to connect to the database
   --schema <schema>          The schema to use for the migrations
   --path <path>              The path to the migrations directory
   --ssl true/false           Whether to use SSL for the connection (default: false)
-  --napply                      Number of up migrations to apply (default: all)
+  --napply                   Number of up migrations to apply (default: all)
   --nundo                    Number of undo migrations to apply (default: 1)
+  --filename                 The filename to get the script for (default: last applied migration)
 
 Example:
   npx stepwise-migrations migrate \\
     --connection=postgresql://postgres:postgres@127.0.0.1:5432/mydatabase \\
     --schema=myschema \\
-    --path=./db/migration/
+    --path=./test/migrations-template/
 `;
 
 export const validateArgs = (argv: any) => {

package/test/index.test.ts

@@ -136,7 +136,7 @@ describe.only("invalid migrations", async () => {
     });
   });
 
-  it.only("missing undo migration", async () => {
+  it("missing undo migration", async () => {
     assertIncludesAll(await executeCommand("migrate", paths.invalid), [
       "All done!",
     ]);
@@ -163,4 +163,15 @@ describe.only("invalid migrations", async () => {
       "Versioned migration v1_first.sql has been altered. Cannot migrate in current state.",
     ]);
   });
+
+  it.only("bad creds", async () => {
+    assertIncludesAll(
+      await execute(`npm exec stepwise-migrations info -- \\
+      --connection=postgresql://postgres:badpassword@127.0.0.1:5432/mydb \\
+      --schema=${schema} \\
+      --path=${paths.invalid}
+    `),
+      ["password authentication failed for user"]
+    );
+  });
 });

package/test/migrations-invalid/v1_first.sql

@@ -1 +1,6 @@
-ALTER TABLE test ADD COLUMN test_column TEXT;
+create table first (
+  id serial primary key,
+  name text not null
+);
+
+ALTER TABLE first ADD COLUMN age int;