fix: improve listing of envs

nokome · nokome · commit bb6f56041c64 · 2019-01-15T13:29:06.000+13:00
diff --git a/Dockerfile b/Dockerfile
@@ -0,0 +1 @@
+FROM nix/nixos
diff --git a/README_x.md b/README_x.md
@@ -0,0 +1,49 @@
+
+
+### Environments
+
+```yaml
+packages:
+  - R
+variables:
+  - R_SITE_LIB: /library
+```
+
+
+
+### Create an environment
+
+The `create` command lets you create a new environment
+
+```bash
+nixta create <name> [extends <env1,env2,...>] [adds <pkg1,pkg2,...>] [removes <pkg3,pkg4,...>]
+```
+
+For example, 
+
+```bash
+nixta create myenv extends r adds r-ggplot2,r-rfishbase
+```
+
+
+```yaml
+extends:
+  - r
+adds:
+  - r-ggplot2
+  - r-rfishbase
+```
+
+### Delete an environment
+
+```bash
+nixta delete <name>
+```
+
+For example, 
+
+```bash
+nixta delete myenv
+```
+
+
diff --git a/UTH.md b/UTH.md
@@ -0,0 +1,66 @@
+# Under the hood
+
+This document provides an "under the hood" look into the workings of Nixster. It's intendended for contributors and interested users.
+
+## Nix
+
+
+
+### Normalising package names
+
+One of the things that Nixster needs is a mapping between package names and Nix attribute paths. This allows Nixster to add or remove Nix packages from environments based on their `environ.yaml` file. Sometimes there is consistency between names and attribute paths. For example, the package known on CRAN as `babynames`, has the Nix name `r-babynames-0.3.0` and the attribute name `rPackages.babynames`. Other times there is less consistentcy. For example, the package known on PyPi as `buildbot-grid-view` has the name `python3.7-buildbot-grid-view-1.4.0` and attribute path `python37Packages.buildbot-plugins.grid-view`.
+
+Nixster creates two new columns `name` and `version` by parsing the Nix package name an normalizing it to only contain lowercase letters (`a-z`), digits (`0-9`) and dashes (`-`). To do this, the `nix_name` is parsed
+
+`python-buildbot-grid-view` will install the package with Nix attributue path `python37Packages.buildbot-plugins.grid-view`
+
+
+```bash
+nix-env --query --file "<nixpkgs>" --attr python37Packages --available --attr-path --drv-path --out-path
+```
+
+Which produces a list of 
+
+```bash
+python37Packages.behave                              behave-1.2.6                                                                        /nix/store/y758394y7f23ba30m0n1h52w6hakjg5k-behave-1.2.6.drv                                                                        /nix/store/8jz1c7bwrl8kch6xag7j93lwg0rf4j77-behave-1.2.6
+python37Packages.boost                               boost-1.67_0                                                                        /nix/store/6w3r1wq9snvhx1yvyh4waw8avyjdxffa-boost-1.67_0.drv                                                                        dev=/nix/store/9p5pj3v6mrwhhjj8ynjw6qb5avn354pj-boost-1.67_0-dev;/nix/store/p7ldzl2pbfa6l5pab3n1iq223q53jf4x-boost-1.67_0
+python37Packages.bugseverywhere                      bugseverywhere-1.1.1                                                                /nix/store/wg2l5y71pgjb2925f0rzp7868cc7xc8r-bugseverywhere-1.1.1.drv                                                                /nix/store/i2bln8h615b94wlddjwqmgy1wxblnf3m-bugseverywhere-1.1.1
+python37Packages.caffe                               caffe-1.0                                                                           /nix/store/0x7n1xyrjxlijl9557fpzfk5zc1j6d8y-caffe-1.0.drv                                                                           bin=/nix/store/rj09zb3sxy6n2v9wv3dkg929cjmjymwh-caffe-1.0-bin;/nix/store/n5wxs3hqv5vfgc7858x77x5mk3bqsa4b-caffe-1.0
+```
+
+```bash
+nix-env --query --file "<nixpkgs>" --attr python37Packages --available --meta --json | head -n 30
+```
+
+```bash
+{
+  "python37Packages.behave": {
+    "name": "behave-1.2.6",
+    "system": "x86_64-linux",
+    "meta": {
+      "available": true,
+      "description": "behaviour-driven development, Python style",
+      "homepage": "https://github.com/behave/behave",
+      "isBuildPythonPackage": [
+        {
+          "kernel": {
+            "_type": "kernel",
+            "execFormat": {
+              "_type": "exec-format",
+              "name": "elf"
+            },
+            "families": {},
+            "name": "linux"
+          }
+        },
+        {
+          "kernel": {
+            "families": {
+              "darwin": {
+                "_type": "exec-format",
+                "name": "darwin"
+              }
+            }
+          }
+        }
+```
diff --git a/demo.sh b/demo.sh
@@ -0,0 +1,29 @@
+#!/usr/bin/env bash
+
+# Script for creating CLI demo
+
+# Include the demoing code
+. demo-magic.sh
+clear
+
+# Set some options
+DEMO_PROMPT=$BLUE"$ "
+DEMO_CMD_COLOR=$GREEN
+
+# Alias to cuurent version of CLI in this repo
+alias nixster="npx ts-node src/cli.ts"
+
+# Run the demo!
+
+p "# First we'll change into one of the R example projects"
+pe "cd tests/fixtures/r-spatial"
+
+p "# And take a look at the files in it"
+pe "ls"
+sleep 1
+
+p "# The 'main.R' file is what Dockter will execute within a container"
+p "# It reads in some spatial data and plots it"
+pe "cat main.R"
+sleep 1
+
diff --git a/src/cli.ts b/src/cli.ts
@@ -1,3 +1,5 @@
+#!/usr/bin/env node
+
 /**
  * Module for command line interface (CLI)
  *
@@ -47,10 +49,27 @@ yargs
   }, async (argv: any) => {
     const envs = await Environment.envs()
     output(envs, argv, (envs: any) => {
-      return envs.map((env: any) => {
-        const descr = env.description ? env.description : ''
-        return sprintf('%-40s %-20s %s', chalk.blue.bold(env.name), descr, chalk.gray(env.location))
-      }).join('\n')
+      const layout = '%-15s %-40s %-80s'
+      const header = sprintf(layout, chalk.gray('Ready'), chalk.gray('Name'), chalk.gray('Description')) + '\n'
+      return header + 
+        envs.map((env: any) => {
+          const icon = env.built ? chalk.green('✓') : chalk.yellow('⚪')
+          const name = chalk.blue(env.name)
+          let descr = env.description
+          if (!descr) {
+            if (env.extends && env.extends.length) {
+              descr = `Extends ${env.extends.join(', ')}.`
+            }
+            if (env.adds && env.adds.length) {
+              descr = `Adds ${env.adds.length} packages.`
+            }
+            if (env.removes && env.removes.length) {
+              descr = `Removes ${env.removes.length} packages.`
+            }
+          }
+          descr = ellipsize(descr, 80)
+          return sprintf(layout, icon, name, descr)
+        }).join('\n')
     })
   })
 
diff --git a/src/nix.ts b/src/nix.ts
@@ -1,7 +1,7 @@
 /**
  * Nixster's interface to Nix.
  */
-
+import fs from 'fs'
 import path from 'path'
 
 import Database from 'better-sqlite3'
@@ -261,13 +261,24 @@ export async function search (term: string, type: string = '', limit: number = 1
   return stmt.all(limit)
 }
 
+/**
+ * Has the environment been built yet?
+ *
+ * @param env The environment name
+ */
+export async function built (env: string): Promise<boolean> {
+  return (await location(env)).length > 0
+}
+
 /**
  * Get the location of an environment within the Nix store
  *
  * @param env The environment name
  */
 export async function location (env: string): Promise<string> {
-  const readlink = await spawn('readlink', ['-f', path.join(profiles, env)])
+  const profile = path.join(profiles, env)
+  if (!fs.existsSync(profile)) return ''
+  const readlink = await spawn('readlink', ['-f', profile])
   return readlink.toString().trim()
 }
 
diff --git a/src/store.js b/src/store.js
@@ -0,0 +1,82 @@
+const Dat = require('dat-node')
+const pda = require('pauls-dat-api')
+
+const DIR = '/home/nokome/nixster'
+const KEY = '14f58766270b33ebd18377955c82992214956438e15d22dfb1d0844fa888d8ea'
+
+function share () {
+  Dat(DIR, {}, (err, dat) => {
+    if (err) throw err
+
+    const importer = dat.importFiles({
+      count: true,
+      ignoreDirs: false,
+      watch: true
+    })
+    importer.on('put', (src, dest) => {
+      console.log(`Importing ${src.name} to ${dest.name}`)
+    })
+    importer.on('count', ({files, bytes}) => {
+      console.log(`Importing ${files} files of ${bytes} bytes`)
+    })
+
+    dat.join()
+
+    dat.network.on('connection', () => {
+      console.log('Connection')
+    })
+    
+    const key = dat.key.toString('hex')
+    console.log(`Sharing store at dat://${key}`)
+  })
+}
+
+function files (path, cb) {
+  connect(async dat => {
+    const files = await pda.readdir(dat.archive, path, { recursive: true })
+    
+    console.log('Leaving network')
+    dat.leave()
+    
+    cb(files)
+  })
+}
+
+function sync () {
+  fetch([
+    '/db.sqlite3',
+    '/envs/'
+  ])
+}
+
+function fetch (files) {
+  connect(async dat => {
+    for (let file of files) {
+      await pda.download(dat.archive, file)
+      console.log(`Downloaded ${file}`)
+    }
+    dat.leave()
+  })
+}
+
+function connect (cb) {
+  Dat(DIR + '-client', {key: KEY, sparse: true}, (err, dat) => {
+    if (err) throw err
+
+    console.log('Joining network')
+    dat.join(function (err) {
+      if (err) throw err
+  
+      if (!dat.network.connected || !dat.network.connecting) {
+        console.error('No users currently online for that key.')
+        process.exit(1)
+      }
+    })
+
+    cb(dat)
+  })
+}
+
+module.exports = {
+  share, fetch, sync, files
+}
