Further tidy-up (+ add warning())

Merge branch 'main' into monorepo
Update README and tweak default STACK_DIR
2020-09-23 11:53:34 +02:00 · 2020-09-22 16:15:33 +02:00 · 2020-09-22 16:13:18 +02:00 · 2020-09-22 16:04:28 +02:00
16 changed files with 375 additions and 1349 deletions
--- a/.drone.yml
+++ b/.drone.yml
@ -3,31 +3,11 @@ kind: pipeline
 name: linters
 steps:
  - name: run shellcheck
-    image: koalaman/shellcheck-alpine:latest
+    image: debian:buster
    commands:
-      - shellcheck abra
-
-  - name: run unit tests
-    image: docker:dind
-    commands:
-      - apk add bats git bash
-      - bats tests
-
-  - name: collect code coverage
-    failure: ignore  # until we fix this
-    image: kcov/kcov:latest
-    commands:
-      - apk add bats git bash
-      - kcov . bats tests || true
-
-  - name: send code coverage report to codecov
-    failure: ignore  # until we fix this
-    image: plugins/codecov
-    settings:
-      token:
-        from_secret: codecov_token
-        required: true
-
+      - apt update
+      - apt install -y shellcheck
+      - shellcheck abra installer
 trigger:
  branch:
    - main
--- a/.gitignore
+++ b/.gitignore
@ -1,2 +0,0 @@
-coverage/
-/.venv
--- a/.gitmodules
+++ b/.gitmodules
@ -1,3 +0,0 @@
-[submodule "tests/helpers/mocks"]
-	path = tests/helpers/mocks
-	url = https://github.com/Flamefire/bats-mock.git
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@ -1,20 +1,3 @@
-# abra x.x.x (UNRELEASED)
-
- ???
-
-# abra 0.3.1 (2020-09-27)
-
- Fix installer version
-
-# abra 0.3.0 (2020-09-27)
-
- Add multilogs stack logs implementation ([#8](https://git.autonomic.zone/compose-stacks/abra/issues/8)
- Add beginnings of "monorepo" functionality
-
-# abra 0.2.0 (2020-09-24)
-
- Prepare for swarm install script using script.d ([#12](https://git.autonomic.zone/compose-stacks/planning/issues/12))
-
 # abra 0.1.2 (2020-09-22)

 - Add upgrade command ([#10](https://git.autonomic.zone/autonomic-cooperative/abra/issues/10))
--- a/46
+++ b/46
@ -1,42 +1,14 @@
-.PHONY: test shellcheck docopt kcov codecov
+default: install

-test:
-	@DOCKER_CONTEXT=default docker run \
-		-it \
-		--rm \
-		-v $$(pwd):/workdir \
-		--privileged \
-		docker:dind \
-		sh -c "apk add bats git bash && cd /workdir && bats tests"
-
-shellcheck:
-	@docker run \
-		-it \
-		--rm \
-		-v $$(pwd):/workdir \
-		koalaman/shellcheck-alpine \
-		shellcheck /workdir/abra
-
-docopt:
-	@if [ ! -d ".venv" ]; then \
-		python3 -m venv .venv && \
-		.venv/bin/pip install -U pip setuptools wheel && \
-		.venv/bin/pip install docopt-sh; \
-	fi
-	.venv/bin/docopt.sh abra
-
-kcov:
-	@DOCKER_CONTEXT=default docker run \
-		-it \
-		--rm \
-		-v $$(pwd):/workdir \
-		koinotice/dind-kcov-bats \
-		bash -c "kcov coverage bats tests || true"
+dev_install:
+	ln -sf $(PWD)/abra ~/.local/bin

 install:
 	install abra /usr/bin/abra

-codecov: SHELL:=/bin/bash
-codecov:
-	@bash <(curl -s https://codecov.io/bash) \
-		-s coverage -t $$(pass show hosts/swarm.autonomic.zone/drone/codecov/token)
+get_yq:
+	wget https://github.com/mikefarah/yq/releases/download/3.3.2/yq_linux_amd64 && \
+		chmod +x yq_linux_amd64 && \
+		mv yq_linux_amd64 yq
+
+.PHONY: dev_install install get_yq
--- a/README.md
+++ b/README.md
@ -1,14 +1,56 @@
 # abra

-[![Build Status](https://drone.autonomic.zone/api/badges/coop-cloud/abra/status.svg)](https://drone.autonomic.zone/coop-cloud/abra)
-[![codecov](https://codecov.io/gh/Autonomic-Cooperative/abra/branch/main/graph/badge.svg?token=aX3I5NMRsj)](undefined)
+[![Build Status](https://drone.autonomic.zone/api/badges/autonomic-cooperative/abra/status.svg)](https://drone.autonomic.zone/autonomic-cooperative/abra)

-> https://cloud.autonomic.zone
-
-The cooperative cloud utility belt 🎩🐇
+Docker stack magic 🎩🐇

 ## Install

 ```sh
-curl https://install.abra.autonomic.zone | bash
+curl -fsSL https://install.abra.autonomic.zone | bash
 ```
+
+Specific releases are available via the project [release page](https://git.autonomic.zone/autonomic-cooperative/abra/releases).
+
+## Changes
+
+See [CHANGELOG.md](./CHANGELOG.md).
+
+## Hacking
+
+```sh
+git clone ssh://git@git.autonomic.zone:2222/autonomic-cooperative/abra.git
+cd abra
+make dev_install
+```
+
+See [autonomic-cooperative/installer-scripts](https://git.autonomic.zone/autonomic-cooperative/installer-scripts) for the installer script deployment. To make a release, just add an entry to [CHANGELOG.md](./CHANGELOG.md) and the [installer](./installer) (following [semver](https://semver.org/) please) and then `git tag x.x.x && git push origin main --tags`. If you want the [installer-scripts](https://git.autonomic.zone/autonomic-cooperative/installer-scripts) deployment to pick that up, you'll need to change the version number in the [Makefile](https://git.autonomic.zone/autonomic-cooperative/installer-scripts/src/branch/main/Makefile) and run `make` in that repository and push the changes.
+
+## Specify what to deploy where
+
+You can use `abra` in one of 2 ways:
+
+1. Clone a `compose-stack`, create an `.envrc` in it, and run `abra` in that
+   directory. Be sure to set `ABRA_STACK_DIR=.`
+2. "Monorepo mode": keep all your `compose-stack`s in one directory and all your `env` files in
+   another, e.g.:
+   ```
+	 $ tree
+   .
+   ├── apps
+   │   ├── mediawiki.demo.autonomic.zone.env
+   │   ├── wordpress.demo.autonomic.zone.env
+   └── stacks
+       ├── gitea
+       ├── matrix-synapse
+       ├── mediawiki
+       ├── nextcloud
+       ├── swarmpit
+       ├── traefik
+       └── wordpress
+		$ abra -e apps/mediawiki.demo.autonomic.zone.env deploy
+    ```
+
+## Examples
+
+- `abra run mariadb mysqldump gitea -p'GdIbMeS09SURRktBnm3jcTufsL5z0MPd' | gzip > ../git.autonomic.zone_mariadb_`date +%F`.sql.gz`
--- a/1266
+++ b/1266
--- a/completion/_abra
+++ b/completion/_abra
@ -1,52 +0,0 @@
-#compdef abra
-
-_abra () {
-	local context state line curcontext="$curcontext" ret=1
-	_arguments -n : \
-		{-h,--help}'[Help message]' \
-		'1:commands:(app server)' \
-		'*::arguments:->arguments' \
-		&& ret=0
-
-	case $state in
-		(arguments)
-			curcontext="${curcontext%:*:*}:abra-arguments-$words[1]:"
-			case $words[1] in
-				(app)
-					_arguments \
-						'1: :_abra_apps' \
-					&& ret=0
-				;;
-				(server)
-					_arguments \
-						'1:servers:_abra_servers' \
-					&& ret=0
-				;;
-			esac
-		;;
-	esac
-
-	return ret
-}
-
-_abra_servers() {
-	_path_files -/W $HOME/.abra/servers
-}
-
-_abra_apps()
-{
-	local newapps apps=($HOME/.abra/servers/*/*.env)
-	typeset -a apps
-	newapps=()
-	for app in $apps; do
-		newapps+=($(_abra_basename "${app}"))
-	done
-	_describe -t apps 'app' newapps
-}
-
-_abra_basename()
-{
-    printf -- "${1##*/}"
-}
-
-_abra "$@"
--- a/completion/abra.bash
+++ b/completion/abra.bash
@ -1,117 +0,0 @@
-#!/usr/bin/env bash
-
-_abra_basename()
-{
-    echo "${1##*/}"
-}
-
-_abra_servers()
-{
-    # FIXME 3wc: copied from abra/get_servers()
-    shopt -s nullglob dotglob
-    local SERVERS=(~/.abra/servers/*)
-    shopt -u nullglob dotglob
-
-    for SERVER in "${SERVERS[@]}"; do
-        _abra_basename "${SERVER}"
-    done
-}
-
-_abra_complete_servers()
-{
-    mapfile -t COMPREPLY < <(compgen -W "$(_abra_servers)" -- "$1")
-}
-
-_abra_apps()
-{
-    shopt -s nullglob dotglob
-    local APPS=(~/.abra/servers/*/*.env)
-    shopt -u nullglob dotglob
-
-    for APP in "${APPS[@]}"; do
-        _abra_basename "${APP%.env}"
-    done
-}
-
-_abra_complete_apps()
-{
-    mapfile -t COMPREPLY < <(compgen -W "$(_abra_apps)" -- "$1")
-}
-
-_abra_complete()
-{
-    compopt +o default +o nospace
-    COMPREPLY=()
-
-    local -r cmds='
-        app
-        server
-    '
-    local -r short_opts='-e      -h     -s      -v'
-    local -r long_opts='--env --help --stack --version'
-
-    # Scan through the command line and find the abra command
-    # (if present), as well as its expected position.
-    local cmd
-    local cmd_index=1 # Expected index of the command token.
-    local i
-    for (( i = 1; i < ${#COMP_WORDS[@]}; i++ )); do
-        local word="${COMP_WORDS[i]}"
-        case "$word" in
-            -*)
-                ((cmd_index++))
-                ;;
-            *)
-                cmd="$word"
-                break
-                ;;
-        esac
-    done
-
-    local cur="${COMP_WORDS[COMP_CWORD]}"
-
-    if (( COMP_CWORD < cmd_index )); then
-        # Offer option completions.
-        case "$cur" in
-            --*)
-                mapfile -t COMPREPLY < <(compgen -W "$long_opts" -- "$cur")
-                ;;
-            -*)
-                mapfile -t COMPREPLY < <(compgen -W "$short_opts" -- "$cur")
-                ;;
-            *)
-                # Skip completion; we should never get here.
-                ;;
-        esac
-    elif (( COMP_CWORD == cmd_index )); then
-        # Offer command name completions.
-        mapfile -t COMPREPLY < <(compgen -W "$cmds" -- "$cur")
-    else
-        # Offer command argument completions.
-        case "$cmd" in
-            server)
-                # Offer exactly one server name completion.
-                if (( COMP_CWORD == cmd_index + 2 )); then
-                    _abra_complete_servers "$cur"
-                fi
-                ;;
-            app)
-                # Offer exactly one app completion.
-                if (( COMP_CWORD == cmd_index + 1 )); then
-                    _abra_complete_apps "$cur"
-                fi
-                ;;
-            #help)
-            #    # Offer exactly one command name completion.
-            #    if (( COMP_CWORD == cmd_index + 1 )); then
-            #        COMPREPLY=($(compgen -W "$cmds" -- "$cur"))
-            #    fi
-            #    ;;
-            *)
-                # Unknown command or unknowable argument.
-                ;;
-        esac
-    fi
-}
-
-complete -o default -F _abra_complete abra
--- a/installer/installer
+++ b/installer/installer
@ -1,7 +1,7 @@
 #!/bin/bash

-ABRA_VERSION="0.3.1"
-ABRA_SRC="https://git.autonomic.zone/coop-cloud/abra/raw/tag/$ABRA_VERSION/abra"
+ABRA_VERSION="0.1.2"
+ABRA_SRC="https://git.autonomic.zone/autonomic-cooperative/abra/raw/tag/$ABRA_VERSION/abra"

 function install_abra {
  mkdir -p "$HOME/.local/bin"
--- a/installer/compose.yml
+++ b/installer/compose.yml
@ -1,40 +0,0 @@
---
-version: "3.8"
-
-services:
-  abra_installer:
-    image: "nginx:stable"
-    configs:
-      - source: abra_conf
-        target: /etc/nginx/conf.d/abra.conf
-      - source: abra_installer
-        target: /var/www/abra-installer/installer
-    volumes:
-      - "public:/var/www/abra-installer"
-    networks:
-      - proxy
-    deploy:
-      update_config:
-        failure_action: rollback
-        order: start-first
-      labels:
-        - "traefik.enable=true"
-        - "traefik.http.services.abra-installer.loadbalancer.server.port=80"
-        - "traefik.http.routers.abra-installer.rule=Host(`install.abra.autonomic.zone`)"
-        - "traefik.http.routers.abra-installer.entrypoints=web-secure"
-        - "traefik.http.routers.abra-installer.tls.certresolver=production"
-
-configs:
-  abra_installer:
-    name: abra_installer_v1
-    file: installer
-  abra_conf:
-    name: abra_conf_v1
-    file: nginx.conf
-
-networks:
-  proxy:
-    external: true
-
-volumes:
-  public:
--- a/installer/nginx.conf
+++ b/installer/nginx.conf
@ -1,10 +0,0 @@
-server {
-  listen         80 default_server;
-  server_name    install.abra.autonomic.zone;
-
-  location / {
-    root /var/www/abra-installer;
-    add_header Content-Type text/plain;
-    index installer;
-  }
-}
--- a/test/abra.yml
+++ b/test/abra.yml
@ -0,0 +1,7 @@
+---
+name: mystack
+secrets:
+  foo:
+  bar:
+  baz:
+    length: 128
--- a/tests/01_environment.bats
+++ b/tests/01_environment.bats
@ -1,17 +0,0 @@
-#!/usr/bin/env bats
-
-@test "docker is available" {
-    command -v docker
-}
-
-@test "abra is executable" {
-    ./abra --help
-}
-
-@test "git is available" {
-    command -v git
-}
-
-@test "running in a container" {
-    ls /etc/alpine-release
-}
--- a/tests/02_abra.bats
+++ b/tests/02_abra.bats
@ -1,60 +0,0 @@
-#!/usr/bin/env bats
-
-load test_helper
-
-setup() {
-    export ABRA_DIR=$(mktemp -d)
-    export DOCKER_STUB_DEBUG=foo
-    mkdir -p $ABRA_DIR/servers/default
-    stub docker \
-        "context create * --docker * : touch $ABRA_DIR/context" \
-        'context ls : echo "swarm.test.com"' \
-        "context rm * : rm $ABRA_DIR/context" \
-        "context create * --docker * : touch $ABRA_DIR/context" \
-        "context rm * : rm $ABRA_DIR/context"
-}
-
-teardown() {
-    #unstub docker
-    #rm -rf "$ABRA_DIR"
-    echo "foo"
-}
-
-@test "abra server add/rm works" {
-    ./abra server add swarm.test.com
-    docker context ls | grep swarm.test.com
-    [ -d $ABRA_DIR/servers/swarm.test.com ]
-    ./abra server rm swarm.test.com
-
-    ./abra server add swarm.test.com foobar 12345
-    [ -d $ABRA_DIR/servers/swarm.test.com ]
-    ./abra server rm swarm.test.com
-}
-
-@test "abra app new/rm works" {
-    ./abra app new --server default --domain traefik.test.com traefik
-    [ -f $ABRA_DIR/servers/default/traefik.test.com.env ]
-
-    # interactive prompt
-    echo "y" | ./abra app traefik.test.com delete
-    [ ! -f $ABRA_DIR/servers/default/traefik.test.com.env ]
-
-    # --force
-    ./abra app new --server default --domain traefik.test.com traefik
-    ./abra app traefik.test.com delete --force
-    [ ! -f $ABRA_DIR/servers/default/traefik.test.com.env ]
-}
-
-@test "abra app <domain> secret (insert|generate|rm)" {
-    # TODO 3wc: mock `server new` so we don't endlessly re-test it
-    ./abra app new --server default --domain traefik.test.com traefik
-
-    ./abra app traefik.test.com secret insert foobar v1 "foobar"
-
-    # interactive prompt
-    echo "y" | ./abra app traefik.test.com secret rm foobar
-
-    ./abra app traefik.test.com secret insert foobar v1 "foobar"
-    #  prompt
-    ./abra app traefik.test.com secret rm foobar --force
-}
--- a/tests/test_helper.bash
+++ b/tests/test_helper.bash
@ -1 +0,0 @@
-load helpers/mocks/src/stub
Author	SHA1	Message	Date
3wc	66013f6ddb	Further tidy-up (+ add warning())	2020-09-23 11:53:34 +02:00
3wc	3d3d6b9b67	Merge branch 'main' into monorepo	2020-09-22 16:15:33 +02:00
3wc	eec1dcb0b2	Update README and tweak default STACK_DIR	2020-09-22 16:13:18 +02:00
3wc	1d52c0f5ed	Add -e, -c and ABRA_STACK_DIR options.. ..and tidy up a little	2020-09-22 16:04:28 +02:00