Merge pull request #7 from shelfio/develop

V1.0.0

Author: harazdovskiy

.circleci/config.yml

@@ -1,12 +1,12 @@
-version: 2.1
-
 orbs:
-  node: circleci/[email protected]
+  node: circleci/[email protected]
+
+version: 2.1
 
 parameters:
   node_version:
     type: string
-    default: '16.15.0'
+    default: '16.17.0'
 
 commands:
   install_deps:
@@ -17,17 +17,17 @@ commands:
           cache-only-lockfile: true
           app-dir: ~/repo
           override-ci-command: yarn install --pure-lockfile --no-progress
-      - run: sudo apt-get -q update && sudo apt-get -y install openjdk-17-jdk
+      - run: sudo apt update -q && sudo apt install postgresql-12
 
 jobs:
   build:
     executor:
       name: node/default
-      tag: << pipeline.parameters.node_version >>
+      tag: <<pipeline.parameters.node_version>>
     working_directory: ~/repo
     steps:
       - checkout
       - install_deps
-      - run: yarn test
+      - run: sudo yarn test
       - run: yarn type-check
       - run: yarn lint:ci

README.md

@@ -1,4 +1,4 @@
-# postgres-local [![CircleCI](https://circleci.com/gh/shelfio/postgres-local/tree/master.svg?style=svg)](https://circleci.com/gh/shelfio/postgres-local/tree/master) ![](https://img.shields.io/badge/code_style-prettier-ff69b4.svg) [![npm (scoped)](https://img.shields.io/npm/v/@shelf/postgres-local.svg)](https://www.npmjs.com/package/@shelf/postgres-local)
+# postgres-local [![CircleCI](https://dl.circleci.com/status-badge/img/gh/shelfio/postgres-local/tree/master.svg?style=svg)](https://dl.circleci.com/status-badge/redirect/gh/shelfio/postgres-local/tree/master) ![](https://img.shields.io/badge/code_style-prettier-ff69b4.svg) [![npm (scoped)](https://img.shields.io/npm/v/@shelf/postgres-local.svg)](https://www.npmjs.com/package/@shelf/postgres-local)
 
 > Run any version of Postgres locally
 
@@ -17,18 +17,26 @@ import {start} from '@shelf/postgres-local';
 
 await start({
   seedPath: "schema.sql",
-  version: 14
+  version: 14,
+  port: 5555,
+  includeInstallation: true
 });
 ```
+ - `seedPath` - absolute path to sql file with commands that will set up db structure before tests
+ - `includeInstallation`
+   - when this flag is `true` (default) macOS will run `brew install` and linux `apt install` to make sure `postgres` is installed
+   - when false - package omit installing postgres and relly that it is already in place
 
 ### 2. Stop Postgres
 
 ```js
 import {stop} from '@shelf/postgres-local';
 
-await stop(14);
+await stop({version: 14});
 ```
 
+
+
 ## Publish
 
 ```sh

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@shelf/postgres-local",
-  "version": " 0.2.0-alpha",
-  "description": "Run 14 version of Postgres locally",
+  "version": "1.0.0",
+  "description": "Run Postgres locally",
   "keywords": [
     "postgres",
     "postgres local"

src/index.test.ts

@@ -4,10 +4,16 @@ import postgres from 'postgres';
 import {start, stop} from '.';
 
 describe('#postgres', () => {
-  it('should start postgres@14 locally', async () => {
-    const returnedUrl = await start({seedPath: `${cwd()}/src/schema.sql`});
+  it('should start postgres locally', async () => {
+    expect.assertions(2);
 
-    const sql = postgres('postgres://localhost:5432/postgres');
+    const returnedUrl = await start({
+      seedPath: `${cwd()}/src/schema.sql`,
+      version: 12,
+      includeInstallation: false,
+    });
+
+    const sql = postgres(returnedUrl);
 
     const data = await sql`
       SELECT attname, format_type(atttypid, atttypmod)
@@ -47,14 +53,15 @@ describe('#postgres', () => {
         format_type: 'boolean',
       },
     ]);
-
-    expect(returnedUrl).toEqual('postgres://localhost:5432/postgres');
+    expect(returnedUrl).toEqual('postgres://localhost:5555/postgres');
   });
 
-  it('should stop postgres@14 locally', async () => {
-    await stop();
+  it('should stop postgres locally', async () => {
+    await stop({
+      version: 12,
+    });
     try {
-      const sql = postgres('postgres://localhost:5432/postgres');
+      const sql = postgres('postgres://localhost:5555/postgres');
 
       await sql`create schema supertest`;
     } catch (e) {

src/index.ts

@@ -1,27 +1,30 @@
 import getDebug from 'debug';
-import {exec} from 'child_process';
+import {spawnSync} from 'child_process';
 import postgres from 'postgres';
-import {promisify} from 'util';
-
-const asyncExec = promisify(exec);
-import cwd from 'cwd';
 import {platform} from 'os';
 
 const debug = getDebug('postgres-local');
-const FILEPATH_PREFIX = `${cwd()}/node_modules/.cache/@shelf/postgres-local`;
+const PD_TEMP_DATA_PATH = `/tmp/postgres-local-${Date.now()}`;
 
-type StartESOptions = {
+export async function start(options: {
   seedPath?: string;
   version?: number;
-};
-
-export async function start(options: StartESOptions): Promise<string> {
-  const {seedPath, version = 14} = options;
+  port?: number;
+  includeInstallation?: boolean;
+}): Promise<string> {
+  const {seedPath, version = 14, port = 5555, includeInstallation = false} = options;
 
-  const url = 'postgres://localhost:5432/postgres';
+  const url = `postgres://localhost:${port}/postgres`;
 
   try {
-    await asyncExec(getInstallationScript(version));
+    spawnSync(getInstallationScript({version, port, includeInstallation}), {
+      stdio: 'inherit',
+      shell: true,
+      env: {
+        ...process.env,
+        HOME: '/root',
+      },
+    });
 
     debug('Connecting to postgres...');
     const sql = postgres(url);
@@ -41,47 +44,60 @@ export async function start(options: StartESOptions): Promise<string> {
   }
 }
 
-export async function stop(version?: string): Promise<{stdout: string; stderr: string}> {
-  return asyncExec(getStopScript(version));
+export function stop({version = 14}: {version?: number}): void {
+  spawnSync(getStopScript({version}), {
+    stdio: 'inherit',
+    shell: true,
+  });
 }
 
-export function getInstallationScript(version: number): string {
+export function getInstallationScript({
+  version = 14,
+  port = 5555,
+  includeInstallation: includeInstallation = false,
+}): string {
   switch (platform()) {
     case 'darwin': {
+      const installation = includeInstallation ? `brew install postgresql@${version};` : '';
+
       return `
-        brew install postgresql@${version}
-        mkdir -p ${FILEPATH_PREFIX}/data;
-        initdb -D ${FILEPATH_PREFIX}/data;
-        pg_ctl -D ${FILEPATH_PREFIX}/data -l ${FILEPATH_PREFIX}/logfile start;
+       ${installation}
+       mkdir -p ${PD_TEMP_DATA_PATH}/data;
+       initdb -D ${PD_TEMP_DATA_PATH}/data;
+       pg_ctl -D ${PD_TEMP_DATA_PATH}/data -o "-F -p ${port}" -l ${PD_TEMP_DATA_PATH}/logfile start;
       `;
     }
     case 'win32': {
       throw new Error('Unsupported OS, try run on OS X or Linux');
     }
     default: {
+      // eslint-disable-next-line
+      const installation = includeInstallation ? `sudo apt update; sudo apt install postgresql-${version};` : '';
+
       return `
-        apt-get update
-        apt-get install -y postgresql-${version}
-        mkdir -p ${FILEPATH_PREFIX}/data;
-        /usr/lib/postgresql/${version}/bin/initdb -D ${FILEPATH_PREFIX}/data;
-        /usr/lib/postgresql/${version}/bin/pg_ctl -D ${FILEPATH_PREFIX}/data -l ${FILEPATH_PREFIX}logfile start;
+        ${installation}
+        sudo -u postgres mkdir -p ${PD_TEMP_DATA_PATH}/data;
+        sudo -u postgres /usr/lib/postgresql/${version}/bin/initdb -D ${PD_TEMP_DATA_PATH}/data;
+        sudo -u postgres /usr/lib/postgresql/${version}/bin/pg_ctl -o "-F -p ${port}" -D ${PD_TEMP_DATA_PATH}/data -l ${PD_TEMP_DATA_PATH}/logfile start;
+        sudo -u postgres createuser -p ${port} -s $(whoami);
+        sudo -u postgres createdb -p ${port} $(whoami);
       `;
     }
   }
 }
 
-export function getStopScript(version?: string): string {
+export function getStopScript({version = 14}): string {
   switch (platform()) {
     case 'darwin': {
       return `
-         pg_ctl stop -D ${FILEPATH_PREFIX}/data
-         rm -rf ${FILEPATH_PREFIX}
+         pg_ctl stop -D ${PD_TEMP_DATA_PATH}/data
+         rm -rf ${PD_TEMP_DATA_PATH}
       `;
     }
     default: {
       return `
-        /usr/lib/postgresql/${version}/bin/pg_ctl -D ${FILEPATH_PREFIX}/data
-        rm -rf ${FILEPATH_PREFIX}
+        sudo -u postgres /usr/lib/postgresql/${version}/bin/pg_ctl stop -D ${PD_TEMP_DATA_PATH}/data
+        sudo -u postgres rm -rf ${PD_TEMP_DATA_PATH}
       `;
     }
   }