Merge pull request #136 from edge/develop

v1.8.5

Author: annybs

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@edge/cli",
-  "version": "1.8.4",
+  "version": "1.8.5",
   "description": "Command line interface for the Edge network",
   "private": true,
   "author": "Edge Network <[email protected]>",

package.json

@@ -4,10 +4,10 @@
 
 import * as sg from '@edge/stargate-utils'
 import { Command } from 'commander'
-import { Context } from '../main'
 import config from '../config'
 import dotenv from 'dotenv'
 import { AuthConfig, DockerOptions } from 'dockerode'
+import { Context, Network } from '../main'
 import { existsSync, readFileSync } from 'fs'
 
 /** Docker environment (env) options. */
@@ -22,6 +22,21 @@ export type EnvFileOption = {
   envFile?: string
 }
 
+/** Docker extra hosts options. */
+export type ExtraHostsOption = {
+  /** Extra hosts configuration for a Docker container. */
+  extraHosts: string[]
+}
+
+/** Docker Gateway options. */
+export type GatewayOption = {
+  /**
+   * Gateway host - a specialised extra host configuration.
+   * See `ExtraHostsOption`
+   */
+  gateway?: string
+}
+
 /** Docker networking options. */
 export type NetworksOption = {
   /** Docker networks for a container to join. */
@@ -34,6 +49,15 @@ export type PrefixOption = {
   prefix?: string
 }
 
+/** Docker Stargate options. */
+export type StargateOption = {
+  /**
+   * Stargate host - a specialised extra host configuration.
+   * See `ExtraHostsOption`
+   */
+  stargate?: string
+}
+
 /** Docker image tag options. */
 export type TargetOption = {
   /** Target tag of image to use. This is the `:version` component of the full tag. */
@@ -56,11 +80,25 @@ export const configureEnv = (cmd: Command): void => {
   cmd.option('-e, --env <var...>', 'set environment variable(s) for node')
 }
 
+/**
+ * Configure a command with extra hosts for Docker.
+ * This option breaks the naming pattern within this file as `add-host` is more understandable and consistent with
+ * the equivalent usage in `docker run`.
+ */
+export const configureExtraHosts = (cmd: Command): void => {
+  cmd.option('--add-host <host...>', 'configure /etc/hosts within node')
+}
+
 /** Configure a command with a Docker env file. */
 export const configureEnvFile = (cmd: Command): void => {
   cmd.option('--env-file <path>', 'set environment variables file for node')
 }
 
+/** Configure a command with a Docker Gateway host. */
+export const configureGateway = (cmd: Command): void => {
+  cmd.option('--gateway <host>', 'set Gateway host for node (if applicable)')
+}
+
 /** Configure a command with Docker networking options. */
 export const configureNetworks = (cmd: Command): void => {
   cmd.option('--network <var...>', 'set network(s) for node')
@@ -71,6 +109,11 @@ export const configurePrefix = (cmd: Command): void => {
   cmd.option('--prefix <prefix>', 'Docker entity prefix')
 }
 
+/** Configure a command with a Docker Stargate host. */
+export const configureStargate = (cmd: Command): void => {
+  cmd.option('--stargate <host>', 'set Stargate host for node (if applicable)')
+}
+
 /** Configure a command with Docker image tag options. */
 export const configureTarget = (cmd: Command): void => {
   cmd.option('--target <version>', 'node target version')
@@ -99,6 +142,16 @@ export const readAllEnv = (cmd: Command): EnvOption => {
   return { env }
 }
 
+/** Read **all** extra host options for the Docker container from a command, including Gateway and Stargate hosts. */
+export const readAllExtraHosts = (cmd: Command, network: Network): ExtraHostsOption => {
+  const { extraHosts } = readExtraHosts(cmd)
+  const { gateway } = readGateway(cmd)
+  if (gateway) extraHosts.push(`${network.gateway.host}:${gateway}`)
+  const { stargate } = readStargate(cmd)
+  if (stargate) extraHosts.push(`${network.stargate.host}:${stargate}`)
+  return { extraHosts }
+}
+
 /** Read Docker registry authentication options from a command. */
 export const readAuth = (cmd: Command): AuthConfig | undefined => {
   const opts = cmd.opts()
@@ -144,6 +197,20 @@ export const readEnvFile = (cmd: Command): EnvFileOption => {
   return { envFile: undefined }
 }
 
+/** Read Docker extra hosts option from a command. */
+export const readExtraHosts = (cmd: Command): ExtraHostsOption => {
+  const opts = cmd.opts()
+  return {
+    extraHosts: opts.addHost !== undefined ? opts.addHost : []
+  }
+}
+
+/** Read Docker Gateway option from a command. */
+export const readGateway = (cmd: Command): GatewayOption => {
+  const opts = cmd.opts()
+  return { gateway: opts.gateway }
+}
+
 /** Read Docker network options from a command. */
 export const readNetworks = (cmd: Command): NetworksOption => {
   const opts = cmd.opts()
@@ -160,10 +227,16 @@ export const readPrefix = (cmd: Command): PrefixOption => {
   return { prefix: opts.prefix }
 }
 
+/** Read Docker Stargate option from a command. */
+export const readStargate = (cmd: Command): StargateOption => {
+  const opts = cmd.opts()
+  return { stargate: opts.stargate }
+}
+
 /** Read Docker image tag options from a command. */
 export const readTarget = async ({ cmd, network }: Context, name: string): Promise<TargetOption> => {
   const opts = cmd.opts()
   return {
-    target: opts.target || (await sg.service.get(network.stargate.host, name)).version
+    target: opts.target || (await sg.service.get(network.stargate.url, name)).version
   }
 }

src/cli/docker.ts

@@ -2,6 +2,7 @@
 // Use of this source code is governed by a GNU GPL-style license
 // that can be found in the LICENSE.md file. All rights reserved.
 
+import * as cli from '../../cli'
 import * as xeUtils from '@edge/xe-utils'
 import { Command } from 'commander'
 import { Context } from '../../main'
@@ -23,15 +24,21 @@ type NodeInfo = {
   stake: xeUtils.stake.Stake
 }
 
+type Options =
+  cli.docker.EnvOption &
+  cli.docker.ExtraHostsOption &
+  cli.docker.GatewayOption &
+  cli.docker.NetworksOption &
+  cli.docker.PrefixOption &
+  cli.docker.StargateOption
+
 /**
  * Build a container options object for a new Docker container.
  */
 export const createContainerOptions = (
   node: NodeInfo,
   tag: string,
-  env: string[] | undefined,
-  prefix?: string | undefined,
-  networks?: string[]
+  { env, extraHosts, network, prefix }: Options
 ): ContainerCreateOptions => {
   const containerName = [
     'edge',
@@ -58,6 +65,7 @@ export const createContainerOptions = (
         '/var/run/docker.sock:/var/run/docker.sock',
         `${volumeName}:/data`
       ],
+      ExtraHosts: extraHosts.length > 0 ? extraHosts : undefined,
       RestartPolicy: { Name: 'unless-stopped' }
     }
   }
@@ -72,9 +80,9 @@ export const createContainerOptions = (
       '443/tcp': {}
     }
   }
-  if (networks?.length) {
+  if (network?.length) {
     opts.NetworkingConfig = {
-      EndpointsConfig: networks.reduce((e, n) => {
+      EndpointsConfig: network.reduce((e, n) => {
         e[n] = {}
         return e
       }, <EndpointsConfig>{})

src/device/cli/index.ts

@@ -21,6 +21,7 @@ import { Context, Network } from '../../main'
 export const action = (ctx: Context) => async (): Promise<void> => {
   const opts = {
     ...cli.docker.readAllEnv(ctx.cmd),
+    ...cli.docker.readAllExtraHosts(ctx.cmd, ctx.network),
     ...cli.docker.readNetworks(ctx.cmd),
     ...cli.docker.readPrefix(ctx.cmd)
   }
@@ -46,7 +47,7 @@ export const action = (ctx: Context) => async (): Promise<void> => {
   const { debug } = cli.debug.read(ctx.parent)
   await image.pullVisible(docker, targetImage, authconfig, debug)
 
-  const containerOptions = createContainerOptions(node, target, opts.env, opts.prefix, opts.network)
+  const containerOptions = createContainerOptions(node, target, opts)
   log.debug('creating container', { containerOptions })
   const container = await docker.createContainer(containerOptions)
   log.debug('starting container')
@@ -62,8 +63,11 @@ export const command = (ctx: Context): Command => {
   cli.docker.configureAuth(cmd)
   cli.docker.configureEnv(cmd)
   cli.docker.configureEnvFile(cmd)
+  cli.docker.configureExtraHosts(cmd)
+  cli.docker.configureGateway(cmd)
   cli.docker.configureNetworks(cmd)
   cli.docker.configurePrefix(cmd)
+  cli.docker.configureStargate(cmd)
   cli.docker.configureTarget(cmd)
   cmd.action(errorHandler(ctx, checkVersionHandler(ctx, action({ ...ctx, cmd }))))
   return cmd

src/device/cli/start.ts

@@ -73,7 +73,10 @@ export const action = (ctx: Context) => async (): Promise<void> => {
   log.debug('removing container', { id: containerInspect?.Id })
   await container.remove()
 
-  const containerOptions = createContainerOptions(node, target, containerInspect?.Config.Env)
+  const containerOptions = createContainerOptions(node, target, {
+    env: containerInspect?.Config.Env || [],
+    extraHosts: containerInspect?.HostConfig.ExtraHosts || []
+  })
   if (containerInspect && Object.keys(containerInspect.NetworkSettings.Networks).length > 0) {
     const endpoints: EndpointsConfig = {}
     Object.keys(containerInspect.NetworkSettings.Networks).forEach(n => {

src/device/cli/update.ts

@@ -27,14 +27,18 @@ main(process.argv, {
   flags: {
     onboarding: true
   },
+  gateway: {
+    host: 'gateway.edge.network'
+  },
   index: {
     host: 'https://index.xe.network'
   },
   registry: {
     imageName: (app, arch) => `${config.docker.registry.address}/${app}/mainnet-${arch}`
   },
   stargate: {
-    host: 'https://stargate.edge.network'
+    host: 'stargate.edge.network',
+    url: 'https://stargate.edge.network'
   },
   wallet: {
     defaultFile: `${homedir}${sep}.edge${sep}wallet${sep}mainnet.json`

src/main-mainnet.ts

@@ -27,14 +27,18 @@ main(process.argv, {
   flags: {
     onboarding: true
   },
+  gateway: {
+    host: 'gateway.test.network'
+  },
   index: {
     host: 'https://index.test.network'
   },
   registry: {
     imageName: (app, arch) => `${config.docker.registry.address}/${app}/testnet-${arch}`
   },
   stargate: {
-    host: 'https://stargate.test.network'
+    host: 'stargate.test.network',
+    url: 'https://stargate.test.network'
   },
   wallet: {
     defaultFile: `${homedir}${sep}.edge${sep}wallet${sep}testnet.json`

src/main-testnet.ts

@@ -61,14 +61,18 @@ export type Network = {
     latestVersionURL: (os: string, arch: string) => string
   }
   flags: Record<string, boolean>
+  gateway: {
+    host: string
+  }
   index: {
     host: string
   }
   registry: {
     imageName: (app: string, arch: string) => string
   }
   stargate: {
-    host: sg.Host
+    host: string
+    url: sg.Host
   }
   wallet: {
     defaultFile: string