kivik deploy local and other minor changes (#63)

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## [2.0.0-alpha.8] - 2021-04-08
+
+- `kivik deploy local` deploys to a running Kivik instance, unless a deployment with key `local` exists in the RC file.
+- `kivik start` does not deploy by default.
+- RC file deployments can set a `fixtures` flag to determine if deployments should also deploy fixtures. This is false by default.
+- `kivik deploy` checks this flag (as well as the `local.fixtures` for `kivik deploy local`) when deploying.
+- `instance.deployDb(db: string, suffix?: string)` lets test suites deploy one database at a time.
+
 ## [2.0.0-alpha.7] - 2021-04-08
 
 - New CLI invocations: `kivik start`, `kivik watch`, `kivik stop`. `kivik inspect`, `kivik dev` and `kivik instance` are aliases of `kivik watch`, and nothing particularly new happens if you keep using those like you used to. `kivik start` and `kivik stop` start and stop the Kivik instance in the background.
@@ -110,6 +118,7 @@
 - Multiple design document support
 - View (map/reduce) and update function support within design documents
 
+[2.0.0-alpha.8]: https://github.com/crkn-rcdr/kivik/releases/tag/v2.0.0-alpha.8
 [2.0.0-alpha.7]: https://github.com/crkn-rcdr/kivik/releases/tag/v2.0.0-alpha.7
 [2.0.0-alpha.6]: https://github.com/crkn-rcdr/kivik/releases/tag/v2.0.0-alpha.6
 [2.0.0-alpha.5]: https://github.com/crkn-rcdr/kivik/releases/tag/v2.0.0-alpha.5

README.md

@@ -59,6 +59,10 @@ export interface Deployment {
   };
   /** Suffix to append to the end of each database name. Default: `undefined` */
   suffix?: string;
+  /** Whether or not to deploy fixtures along with the design documents. */
+  fixtures?: boolean;
+  /** List of databases to deploy. By default, all databases are deployed. */
+  dbs?: string[];
 }
 
 /** Configuration for Kivik instances. */
@@ -181,10 +185,12 @@ $ kivik deploy production
 import { createKivik } from "kivik";
 
 const kivik = await createKivik("path/to/dir", "deploy");
-await kivik.deployTo("production");
+await kivik.deploy("production");
 await kivik.close();
 ```
 
+If you deploy to `local`, you will deploy to a running Kivik instance (see below), unless you have a deployment with key `local` in your RC file.
+
 ### Instance
 
 ```shell
@@ -235,7 +241,7 @@ test("Your fixture looks good", async (t) => {
 });
 ```
 
-When a Kivik instance is running, Kivik saves its container's name to `$DIR/.kivik.tmp`. If this file is altered or deleted, Kivik won't be able to find the running instance it might be referring to. The file is deleted when a Kivik instance is stopped.
+When a Kivik instance is running, Kivik saves its container's name to `$DIR/.kivik.tmp`. If this file is altered or deleted, Kivik won't be able to find the running instance it might be referring to. The file is deleted when a Kivik instance is stopped. Only one Kivik instance can run at a time.
 
 ## Testing Kivik
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "kivik",
-  "version": "2.0.0-alpha.7",
+  "version": "2.0.0-alpha.8",
   "description": "An opinionated library and command-line utility for configuration CouchDB endpoints, databases, and design documents",
   "keywords": [
     "couchdb"
@@ -19,9 +19,12 @@
     }
   ],
   "license": "Unlicense",
-  "main": "./dist/index.js",
+  "files": [
+    "dist/**"
+  ],
+  "main": "dist/index.js",
   "bin": {
-    "kivik": "./dist/bin.js"
+    "kivik": "dist/bin.js"
   },
   "engines": {
     "node": ">=12.0.0"

src/cli/deploy.ts

@@ -13,27 +13,36 @@ export default (unloggedContext: UnloggedContext) => {
 		command: "deploy <deployment>",
 		describe: "Deploys design documents to a remote database",
 		builder: (yargs: yargs.Argv<CommonArgv>) =>
-			yargs
-				.positional("deployment", {
-					type: "string",
-					describe: "Key of a deployment object in your kivikrc file",
-				})
-				.check((argv: DeployArgv): boolean => {
-					const key = argv.deployment as string;
-					const deployment = unloggedContext.deployments[key];
-
-					if (!deployment)
-						throw new Error(`No deployment in kivikrc for key ${key}`);
-
-					return true;
-				}),
+			yargs.positional("deployment", {
+				type: "string",
+				describe: "Key of a deployment object in your kivikrc file",
+			}),
 		handler: async (argv: DeployArgv) => {
 			const context = unloggedContext.withArgv(argv);
-			const kivik = await createKivik(context, "deploy");
 
-			await kivik.deployTo(argv.deployment as string);
+			let deployment;
+			try {
+				deployment = await context.getDeployment(argv.deployment || "");
+			} catch (error) {
+				context.log("error", error.message);
+				process.exit(1);
+			}
+
+			let kivik;
+			try {
+				kivik = await createKivik(
+					context,
+					deployment.fixtures ? "instance" : "deploy"
+				);
+				await kivik.deploy(deployment);
+				await kivik.close();
+				process.exit(0);
+			} catch (error) {
+				context.log("error", `Error deploying: ${error.message}`);
+				process.exitCode = 1;
+			}
 
-			await kivik.close();
+			if (kivik) await kivik.close();
 		},
 	};
 };

src/cli/start.ts

@@ -10,8 +10,7 @@ export default (unloggedContext: UnloggedContext) => {
 			const context = unloggedContext.withArgv(argv);
 
 			try {
-				const instance = await createInstance(context, false);
-				await instance.deploy();
+				const instance = await createInstance(context, { attach: false });
 				await instance.detach();
 				instance.announce();
 			} catch (error) {

src/cli/stop.ts

@@ -12,6 +12,7 @@ export default (unloggedContext: UnloggedContext) => {
 			try {
 				const instance = await getInstance(context);
 				await instance.stop();
+				context.log("success", "Kivik instance stopped.");
 			} catch (error) {
 				context.log(
 					"error",

src/context/index.ts

@@ -5,12 +5,15 @@ import { sync as findUp } from "find-up";
 
 import { CommonArgv } from "../cli";
 import { createLogger, LogLevel } from "./logger";
-import { normalizeRc, NormalizedRc } from "./rc";
+import { normalizeRc, NormalizedRc, Deployment, NanoDeployment } from "./rc";
+import { get as remoteNano } from "@crkn-rcdr/nano";
+import { getInstance } from "../instance";
 
 export { logLevels, LogLevel } from "./logger";
 
 export {
 	Deployment,
+	NanoDeployment,
 	InstanceConfig,
 	normalizeInstanceConfig,
 	NormalizedInstanceConfig,
@@ -24,6 +27,10 @@ export type UnloggedContext = NormalizedRc & {
 
 export type Context = Omit<UnloggedContext, "withArgv"> & {
 	readonly log: (level: LogLevel, message: string) => void;
+	readonly getDeployment: (
+		key: string,
+		suffix?: string
+	) => Promise<NanoDeployment>;
 	readonly withDatabase: (db: string) => DatabaseContext;
 };
 
@@ -42,16 +49,44 @@ export const createContext = (directory: string): UnloggedContext => {
 	return {
 		directory,
 		...rc,
-		withArgv: function (argv: CommonArgv): Context {
+		withArgv: function (argv: CommonArgv) {
 			// https://no-color.org
 			if (process.env.hasOwnProperty("NO_COLOR")) argv.color = false;
 
 			const logger = createLogger(argv);
+			if (!confPath)
+				logger.log(
+					"warn",
+					"No kivikrc file detected. Proceeding with defaults."
+				);
 			logger.log("info", "Logger initialized.");
 
 			return {
 				...this,
 				log: (level: LogLevel, message: string) => logger.log(level, message),
+				getDeployment: async function (key: string, suffix?: string) {
+					if (key in this.deployments) {
+						const deployment = this.deployments[key] as Deployment;
+						return {
+							nano: remoteNano(deployment.url, deployment.auth),
+							suffix: suffix || deployment.suffix,
+							fixtures: !!deployment.fixtures,
+							dbs: deployment.dbs || null,
+						};
+					} else if (key === "local") {
+						const instance = await getInstance(this);
+						return {
+							nano: instance.nano,
+							suffix,
+							fixtures: this.local.fixtures,
+							dbs: null,
+						};
+					} else {
+						throw new Error(
+							`Your kivikrc file does not have a deployment with key '${key}'`
+						);
+					}
+				},
 				withDatabase: function (db: string): DatabaseContext {
 					return {
 						...this,

src/context/rc.ts

@@ -1,3 +1,5 @@
+import { ServerScope } from "nano";
+
 /** Kivik RC file configuration. */
 export interface Rc {
 	/**
@@ -31,8 +33,19 @@ export interface Deployment {
 	};
 	/** Suffix to append to the end of each database name. Default: `undefined` */
 	suffix?: string;
+	/** Whether or not to deploy fixtures along with the design documents Default: `false`. */
+	fixtures?: boolean;
+	/** List of databases to deploy. By default, all databases are deployed. */
+	dbs?: string[];
 }
 
+export type NanoDeployment = {
+	nano: ServerScope;
+	suffix?: string;
+	fixtures: boolean;
+	dbs: string[] | null;
+};
+
 /** Configuration for Kivik instances. */
 export interface InstanceConfig {
 	/** Deploy fixtures when running `kivik dev`. Default: `true` */

src/instance/container.ts

@@ -6,7 +6,7 @@ import { localhost as localNano } from "@crkn-rcdr/nano";
 import { ServerScope } from "nano";
 import pRetry from "p-retry";
 
-import { Context, NormalizedInstanceConfig } from "../context";
+import { Context } from "../context";
 
 const tempfile = (directory: string) => pathJoin(directory, ".kivik.tmp");
 const getNano = (port: number, context: Context) =>
@@ -50,11 +50,8 @@ export const getContainer = async (context: Context) => {
 	}
 };
 
-export const createContainer = async (
-	context: Context,
-	instanceConfig: NormalizedInstanceConfig
-): Promise<Container> => {
-	const { port: desiredPort, image, user, password } = instanceConfig;
+export const createContainer = async (context: Context): Promise<Container> => {
+	const { port: desiredPort, image, user, password } = context.local;
 
 	const port = await getPort({ port: desiredPort });
 

src/instance/index.spec.ts

@@ -2,7 +2,6 @@ import anyTest, { TestInterface } from "ava";
 
 import { createInstance, Instance } from ".";
 import { directory } from "../example";
-import { DatabaseHandler } from "../kivik";
 
 interface LocalContext {
 	instance: Instance;
@@ -20,8 +19,7 @@ test("Can survive multiple deploys", async (t) => {
 	);
 	await Promise.all(
 		suffixes.map(async (suffix) => {
-			const handlers = await t.context.instance.deploy(suffix);
-			const testdb = handlers.get("testdb") as DatabaseHandler;
+			const testdb = await t.context.instance.deployDb("testdb", suffix);
 			const pickwick = await testdb.get("pickwick-papers");
 			t.is(pickwick["_id"], "pickwick-papers");
 		})