Merge pull request #567 from docwhat/pr/docker

test-in-docker: quickly test frameworks in docker

TESTS.md

@@ -13,10 +13,37 @@ Tests in separate files under `test/functions`.
 These Tests tend to be more complex in setup than the basic tests. To avoid ending
 up in a huge single file, there is one file per segment in `test/segments`.
 
-# Test-VMs
+# Manual Testing
 
 If unit tests are not sufficient (e.g. you have an issue with your prompt that
-occurs only in a specific ZSH framework), then you could use our Test-VMs!
+occurs only in a specific ZSH framework) then you can use either Docker or
+or our Vagrant.
+
+## Docker
+
+This is the easiest to use _if_ you have Docker already installed and running.
+
+The command `./test-in-docker` should make it fairly easy to get into a running
+container with the framework of your choice.
+
+Examples:
+
+``` zsh
+# Test Antigen with the oldest version of ZSH
+$ ./test-in-docker antigen
+```
+
+``` zsh
+# Test Prezto with ZSH version 5.2
+$ ./test-in-docker --zsh 5.2 prezto
+```
+
+You can get Docker at <https://www.docker.com/community-edition>.
+
+**Note:** Not all frameworks work with all versions of ZSH (or the underlying OS).
+
+## Vagrant
+
 Currently there are two test VMs. `test-vm` is an Ubuntu machine with several
 pre-installed ZSH frameworks. And there is `test-bsd-vm` which is a FreeBSD!
 For how to run the machines see [here](test-vm/README.md).

docker/antibody/Dockerfile

@@ -0,0 +1,8 @@
+ARG base
+FROM p9k:${base}
+
+COPY docker/antibody/install.zsh /tmp/
+RUN zsh /tmp/install.zsh
+
+COPY ./ p9k/
+COPY docker/antibody/zshrc .zshrc

docker/antibody/install.zsh

@@ -0,0 +1 @@
+curl -sL https://git.io/antibody | bash -s

docker/antibody/zshrc

@@ -0,0 +1,2 @@
+source <(antibody init)
+antibody bundle ~/p9k/

docker/antigen/Dockerfile

@@ -0,0 +1,8 @@
+ARG base
+FROM p9k:${base}
+
+COPY docker/antigen/install.zsh /tmp/
+RUN zsh /tmp/install.zsh
+
+COPY ./ p9k/
+COPY docker/antigen/zshrc .zshrc

docker/antigen/install.zsh

@@ -0,0 +1,12 @@
+#!/bin/zsh
+
+mkdir ~/antigen
+
+curl \
+  -qLsSf \
+  -o ~/antigen/antigen.zsh \
+  https://git.io/antigen
+
+source ~/antigen/antigen.zsh
+
+# EOF

docker/antigen/zshrc

@@ -0,0 +1,4 @@
+source ~/antigen/antigen.zsh
+
+antigen theme "${HOME}/p9k" powerlevel9k --no-local-clone
+antigen apply

docker/base-4.3.11/Dockerfile

@@ -0,0 +1,31 @@
+FROM centos:6
+
+RUN \
+  yum install -y \
+  curl \
+  git \
+  zsh \
+  mercurial \
+  subversion \
+  golang \
+  jq \
+  node \
+  ruby \
+  python \
+  python-virtualenv \
+  sudo
+
+RUN adduser --shell /bin/zsh --comment 'fred' --user-group fred
+
+COPY docker/fred-sudoers /etc/sudoers.d/fred
+
+USER fred
+WORKDIR /home/fred
+ENV LANG=en_US.UTF-8
+ENV TERM=xterm-256color
+ENV DEFAULT_USER=fred
+ENV POWERLEVEL9K_ALWAYS_SHOW_CONTEXT=true
+
+RUN touch .zshrc
+
+CMD ["/bin/zsh", "-l"]

docker/base-5.0.3/Dockerfile

@@ -0,0 +1,33 @@
+FROM ubuntu:14.04
+
+RUN \
+  apt-get update && \
+  echo 'golang-go golang-go/dashboard boolean false' | debconf-set-selections && \
+  DEBIAN_FRONTEND=noninteractive apt-get install -y \
+  curl \
+  git \
+  zsh \
+  mercurial \
+  subversion \
+  golang \
+  jq \
+  node \
+  ruby \
+  python \
+  python-virtualenv
+
+RUN adduser --shell /bin/zsh --gecos 'fred' --disabled-password fred
+RUN locale-gen "en_US.UTF-8"
+
+COPY docker/fred-sudoers /etc/sudoers.d/fred
+
+USER fred
+WORKDIR /home/fred
+ENV LANG=en_US.UTF-8
+ENV TERM=xterm-256color
+ENV DEFAULT_USER=fred
+ENV POWERLEVEL9K_ALWAYS_SHOW_CONTEXT=true
+
+RUN touch .zshrc
+
+CMD ["/bin/zsh", "-l"]

docker/base-5.1.1/Dockerfile

@@ -0,0 +1,35 @@
+FROM ubuntu:16.04
+
+RUN \
+  apt-get update && \
+  echo 'golang-go golang-go/dashboard boolean false' | debconf-set-selections && \
+  DEBIAN_FRONTEND=noninteractive apt-get install -y \
+  curl \
+  git \
+  zsh \
+  mercurial \
+  subversion \
+  golang \
+  jq \
+  nodejs \
+  ruby \
+  python \
+  python-virtualenv \
+  sudo \
+  locales
+
+RUN adduser --shell /bin/zsh --gecos 'fred' --disabled-password fred
+RUN locale-gen "en_US.UTF-8"
+
+COPY docker/fred-sudoers /etc/sudoers.d/fred
+
+USER fred
+WORKDIR /home/fred
+ENV LANG=en_US.UTF-8
+ENV TERM=xterm-256color
+ENV DEFAULT_USER=fred
+ENV POWERLEVEL9K_ALWAYS_SHOW_CONTEXT=true
+
+RUN touch .zshrc
+
+CMD ["/bin/zsh", "-l"]

docker/base-5.2/Dockerfile

@@ -0,0 +1,35 @@
+FROM ubuntu:17.04
+
+RUN \
+  apt-get update && \
+  echo 'golang-go golang-go/dashboard boolean false' | debconf-set-selections && \
+  DEBIAN_FRONTEND=noninteractive apt-get install -y \
+  curl \
+  git \
+  zsh \
+  mercurial \
+  subversion \
+  golang \
+  jq \
+  nodejs \
+  ruby \
+  python \
+  python-virtualenv \
+  sudo \
+  locales
+
+RUN adduser --shell /bin/zsh --gecos 'fred' --disabled-password fred
+RUN locale-gen "en_US.UTF-8"
+
+COPY docker/fred-sudoers /etc/sudoers.d/fred
+
+USER fred
+WORKDIR /home/fred
+ENV LANG=en_US.UTF-8
+ENV TERM=xterm-256color
+ENV DEFAULT_USER=fred
+ENV POWERLEVEL9K_ALWAYS_SHOW_CONTEXT=true
+
+RUN touch .zshrc
+
+CMD ["/bin/zsh", "-l"]

docker/dotfile/Dockerfile

@@ -0,0 +1,5 @@
+ARG base
+FROM p9k:${base}
+
+COPY ./ p9k/
+COPY docker/dotfile/zshrc .zshrc

docker/dotfile/zshrc

@@ -0,0 +1 @@
+source "${HOME}/p9k/prompt_powerlevel9k_setup"

docker/fred-sudoers

@@ -0,0 +1,2 @@
+Defaults:fred !requiretty
+fred ALL=(ALL) NOPASSWD: ALL

docker/omz/Dockerfile

@@ -0,0 +1,8 @@
+ARG base
+FROM p9k:${base}
+
+COPY docker/omz/install.zsh /tmp/
+RUN zsh /tmp/install.zsh
+
+COPY docker/omz/zshrc .zshrc
+COPY ./ p9k/

docker/omz/install.zsh

@@ -0,0 +1,4 @@
+sh -c "$(curl -fsSL https://raw.githubusercontent.com/robbyrussell/oh-my-zsh/master/tools/install.sh)"
+
+mkdir -p ~/.oh-my-zsh/custom/themes
+ln -nsf ~/p9k/ ~/.oh-my-zsh/custom/themes/powerlevel9k

docker/omz/zshrc

@@ -0,0 +1,5 @@
+export ZSH=$HOME/.oh-my-zsh
+ZSH_THEME="powerlevel9k/powerlevel9k"
+plugins=(git rake ruby)
+
+source $ZSH/oh-my-zsh.sh

docker/prezto/Dockerfile

@@ -0,0 +1,7 @@
+ARG base
+FROM p9k:${base}
+
+COPY docker/prezto/install.zsh /tmp/
+RUN zsh /tmp/install.zsh
+
+COPY ./ p9k/

docker/prezto/install.zsh

@@ -0,0 +1,18 @@
+#!/bin/zsh
+
+set -eu
+
+git clone --recursive https://github.com/sorin-ionescu/prezto.git "${ZDOTDIR:-$HOME}/.zprezto"
+
+setopt EXTENDED_GLOB
+for rcfile in "${ZDOTDIR:-$HOME}"/.zprezto/runcoms/^README.md(.N); do
+  ln -nsf "$rcfile" "${ZDOTDIR:-$HOME}/.${rcfile:t}"
+done
+
+ln -s "${HOME}/p9k/powerlevel9k.zsh-theme" \
+  "${HOME}/.zprezto/modules/prompt/functions/prompt_powerlevel9k_setup"
+
+echo "zstyle ':prezto:module:prompt' theme 'powerlevel9k'" \
+  >> "${HOME}/.zpreztorc"
+
+# EOF

docker/zgen/Dockerfile

@@ -0,0 +1,8 @@
+ARG base
+FROM p9k:${base}
+
+COPY docker/zgen/install.zsh /tmp/
+RUN zsh /tmp/install.zsh
+
+COPY ./ p9k/
+COPY docker/zgen/zshrc .zshrc

docker/zgen/install.zsh

@@ -0,0 +1,5 @@
+#!/bin/zsh
+
+git clone https://github.com/tarjoilija/zgen.git "${HOME}/.zgen"
+
+# EOF

docker/zgen/zshrc

@@ -0,0 +1,10 @@
+# load zgen
+source ~/.zgen/zgen.zsh
+
+# if the init scipt doesn't exist
+if ! zgen saved; then
+  zgen load ~/p9k/powerlevel9k.zsh-theme
+
+  # generate the init script from plugins above
+  zgen save
+fi

docker/zim/Dockerfile

@@ -0,0 +1,7 @@
+ARG base
+FROM p9k:${base}
+
+COPY docker/zim/install.zsh /tmp/
+RUN zsh /tmp/install.zsh
+
+COPY ./ p9k/

docker/zim/install.zsh

@@ -0,0 +1,21 @@
+#!zsh
+
+git clone --recursive https://github.com/Eriner/zim.git "${ZDOTDIR:-${HOME}}/.zim"
+
+setopt EXTENDED_GLOB
+for template_file ( ${ZDOTDIR:-${HOME}}/.zim/templates/* ); do
+  user_file="${ZDOTDIR:-${HOME}}/.${template_file:t}"
+  touch ${user_file}
+  ( print -rn "$(<${template_file})$(<${user_file})" >! ${user_file} ) 2>/dev/null
+done
+
+source "${ZDOTDIR:-${HOME}}/.zlogin"
+
+ln -nsf \
+  ~/p9k/ \
+  ~/.zim/modules/prompt/external-themes/powerlevel9k
+ln -nsf \
+  ~/.zim/modules/prompt/external-themes/powerlevel9k/powerlevel9k.zsh-theme \
+  ~/.zim/modules/prompt/functions/prompt_powerlevel9k_setup
+
+sed -i "s/zprompt_theme='steeef'/zprompt_theme='powerlevel9k'/g" ~/.zimrc

docker/zplug/Dockerfile

@@ -0,0 +1,8 @@
+ARG base
+FROM p9k:${base}
+
+COPY docker/zplug/install.zsh /tmp/
+RUN zsh /tmp/install.zsh
+
+COPY ./ p9k/
+COPY docker/zplug/zshrc .zshrc

docker/zplug/install.zsh

@@ -0,0 +1,5 @@
+#!zsh
+
+curl -sL --proto-redir -all,https https://raw.githubusercontent.com/zplug/installer/master/installer.zsh| zsh
+
+# git clone https://github.com/zplug/zplug "${HOME}/.zplug"

docker/zplug/zshrc

@@ -0,0 +1,5 @@
+#!zsh
+
+source ~/.zplug/init.zsh
+zplug "${HOME}/p9k", use:"powerlevel9k.zsh-theme", from:local, as:theme
+zplug load --verbose

docker/zplugin/Dockerfile

@@ -0,0 +1,8 @@
+ARG base
+FROM p9k:${base}
+
+COPY docker/zplugin/install.zsh /tmp/
+RUN zsh /tmp/install.zsh
+
+COPY ./ p9k/
+COPY docker/zplugin/zshrc.plugins .zshrc.plugins

docker/zplugin/install.zsh

@@ -0,0 +1,12 @@
+sh -c "$(curl -fsSL https://raw.githubusercontent.com/psprint/zplugin/master/doc/install.sh)"
+
+# The 'zplugin snippet' only copies the .zsh-theme file, not everything else.
+mkdir -p ~/.zplugin/snippets
+ln -nsf \
+  ~/p9k/ \
+~/.zplugin/snippets/--SLASH--home--SLASH--fred--SLASH--p9k--SLASH--powerlevel9k--DOT--zsh-theme
+
+{
+  echo
+  echo "source ~/.zshrc.plugins"
+} >> ~/.zshrc

docker/zplugin/zshrc.plugins

@@ -0,0 +1,5 @@
+#!zsh
+
+zplugin load psprint zsh-navigation-tools
+zplugin load psprint---zprompts
+zplugin snippet ~/p9k/powerlevel9k.zsh-theme

docker/zpm/Dockerfile

@@ -0,0 +1,8 @@
+ARG base
+FROM p9k:${base}
+
+COPY docker/zpm/install.zsh /tmp/
+RUN zsh /tmp/install.zsh
+
+COPY ./ p9k/
+COPY docker/zpm/zshrc .zshrc

docker/zpm/install.zsh

@@ -0,0 +1,6 @@
+# install zpm
+git clone --recursive https://github.com/zpm-zsh/zpm.git ~/.zpm
+
+# Install powerlevel9k
+mkdir ~/.zpm/plugins/powerlevel9k
+ln -s ~/p9k/powerlevel9k.zsh-theme ~/.zpm/plugins/powerlevel9k/powerlevel9k.plugin.zsh

docker/zpm/zshrc

@@ -0,0 +1,3 @@
+source ~/.zpm/zpm.zsh
+
+zpm load powerlevel9k

docker/zulu/Dockerfile

@@ -0,0 +1,7 @@
+ARG base
+FROM p9k:${base}
+
+COPY docker/zulu/install.zsh /tmp/
+RUN zsh /tmp/install.zsh
+
+COPY ./ p9k/

docker/zulu/install.zsh

@@ -0,0 +1,10 @@
+#!zsh
+
+# install zulu https://github.com/zulu-zsh/zulu
+curl -L https://git.io/zulu-install | zsh && zsh
+
+{
+echo 'zulu fpath add ~/p9k'
+echo 'zulu fpath add ~/p9k/functions'
+echo 'zulu theme powerlevel9k'
+} >> ~/.zshrc

test-in-docker

@@ -0,0 +1,157 @@
+#!/usr/bin/env zsh
+
+set -eu
+
+# The default ZSH to use.
+default_version='4.3.11'
+
+setopt extended_glob glob_subst numeric_glob_sort
+cd "${${(%):-%x}:A:h}"
+
+# TODO: Crazy Logic to munge TERM to something supported in Ubuntu 14.04
+term=screen-256color
+
+# Note: If versions and frameworks looks complicated, it isn't that bad...
+# ...see Modifiers in zshexpn(1) for details.
+
+# List of ZSH versions
+typeset -a versions
+versions=( docker/base-*/Dockerfile(N.on:h:t:s/base-//) )
+
+# List of frameworks
+typeset -a frameworks
+frameworks=( docker/*/Dockerfile(N.on:h:t) )
+frameworks=${(@)frameworks:#base-*}
+
+err()
+{
+  print -P "%F{red}Error:%f $*"
+  exit 2
+}
+
+resolve_framework() {
+  local f=$1 found
+  found=${frameworks[(In:-1:)$f*]}
+  if (( found <= $#frameworks )); then
+    echo "${frameworks[$found]}"
+  fi
+}
+
+resolve_version() {
+  local v=$1 found
+  found=${versions[(In:-1:)$v*]}
+  if (( found <= $#versions )); then
+    echo "${versions[$found]}"
+  fi
+}
+
+build_and_run() {
+  local version="$1"
+  local framework="$2"
+  local name="${version}-${framework}"
+
+  print -P "%F{green}Preparing containers...%f"
+
+  echo -n "p9k:base-${version}: "
+  docker build \
+    --quiet \
+    --tag "p9k:base-${version}" \
+    --file "docker/base-${version}/Dockerfile" \
+    .
+
+  echo -n "p9k:${version}-${framework}: "
+  docker build \
+    --quiet \
+    --build-arg="base=base-${version}" \
+    --tag "p9k:${version}-${framework}" \
+    --file "docker/${framework}/Dockerfile" \
+    .
+
+  print -P "%F{green}Starting ${name} container...%f"
+  exec docker run \
+    --rm \
+    --interactive \
+    --tty \
+    --hostname="${name//./_}" \
+    --env="TERM=${term}" \
+    "p9k:${version}-${framework}"
+}
+
+show_help() {
+  local f v
+  echo "Usage: ${(%):-%x} <framework>|--list"
+  echo
+  echo "Loads up a docker image with powershell9k configured in <framework>"
+  echo
+  echo "  --frameworks  Lists all available frameworks, newline separated."
+  echo "  --versions    Lists all available ZSH versions, newline separated."
+  echo "  --zsh VER     Uses ZSH with version VER."
+  echo "  --help        You're soaking in it."
+  echo
+  echo "ZSH versions:"
+  for v in "${(@)versions}"; do
+    echo "  $v"
+  done
+  echo
+  echo "Framework containers:"
+  for f in "${(@)frameworks}"; do
+    echo "  $f"
+  done
+}
+
+# No arguments
+if (( $# == 0 )); then
+  show_help
+  exit
+fi
+
+# Parse flags and such.
+use_version=$default_version
+use_framework=
+while (( $# > 0 )); do
+  case "$1" in
+    -f | --frameworks )
+      print -l "${(@)frameworks}"
+      exit
+      ;;
+    -v | --versions )
+      print -l "${(@)versions}"
+      exit
+      ;;
+    -z | --zsh )
+      shift
+      local v="$(resolve_version "$1")"
+      if [[ -n "$v" ]]; then
+        use_version=$v
+      else
+        err "No such ZSH version '${1}'"
+      fi
+      ;;
+    -h | --help )
+      show_help
+      exit
+      ;;;
+    -* )
+      err "Unknown option ${1}"
+      show_help
+      exit 1
+      ;;
+    * )
+      if [[ -z "$use_framework" ]]; then
+        local f="$(resolve_framework "$1")"
+        if [[ -n "$f" ]]; then
+          use_framework=$f
+        else
+          err "No such framework '${1}'"
+        fi
+      else
+        err "You can only specify one framework at a time; you already specified '${use_framework}'"
+      fi
+      ;;
+  esac
+  shift
+done
+
+build_and_run "$use_version" "$use_framework"
+
+# EOF