import hypernode-vagrant-runner

from https://github.com/vdloo/hypernode-vagrant-runner

runtests.sh

@@ -13,3 +13,6 @@ ruby -e "require 'yaml';YAML.load_file('$DIRNAME/.local.base.yml')" \
 echo "Running vagrant-hypconfigmgmt tests.."
 # run vagrant-hypconfigmgmt tests
 (cd "$DIRNAME/vagrant/plugins/vagrant-hypconfigmgmt/" && make test)
+
+# run hypernode-vagrant-runner tests
+(cd "$DIRNAME/tools/hypernode-vagrant-runner/" && bash runtests.sh -1)

tools/README.md

@@ -0,0 +1,3 @@
+# Supplementary tools
+
+This directory contains tools directly relating to the hypernode-vagrant project but are not essential for basic provisioning.

tools/hypernode-vagrant-runner/.gitignore

@@ -0,0 +1,10 @@
+# PyCharm
+.idea
+
+# Vim
+.swp
+.swo
+
+# Python
+*.pyc
+venv

tools/hypernode-vagrant-runner/LICENSE.txt

@@ -0,0 +1,23 @@
+Copyright (c) 2016 Rick van de Loo
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

tools/hypernode-vagrant-runner/README.md

@@ -0,0 +1,173 @@
+# hypernode-vagrant-runner
+
+Run your project inside a [hypernode-vagrant](http://github.com/ByteInternet/hypernode-vagrant) Virtual Machine by adding one file to your project.
+
+## What is this?
+
+This project is a program that automatically creates a hypernode-vagrant checkout in a temporary directory, boots the VM, uploads the specified project and runs a command in the uploaded directory and then cleans it all up again after the tests have finished. The default configuration is a loop where you can alter files on the host, press ENTER in the test-prompt and have the program automatically sync the files and run the tests again.  
+
+Why run tests in a Vagrant? There are many reasons. One is that you completely eliminate 'state' by throwing away the test environment. For example, if you happened to have installed a package or made a change on your host system that is not in a real Hypernode, then your code might work locally but not in production. Same goes for changes between revisions.  There could be slightly different PHP version, etc.  A second reason is that the host system does not have to have the requirements installed to run the tests because they can be contained to the Vagrant guest. 
+
+I personally mostly develop in Python so not having to worry about having composer or whatever web package du jour installed locally saves me some time in not having to first explore an ecosystem that I am not too familiar with before making code changes. 
+
+Only for Linux and Mac
+
+## Usage
+
+The help menu:
+```bash
+PYTHONPATH=. ./bin/start_runner.py --help
+```
+
+Boot a hypernode-vagrant and get an SSH shell
+```bash
+PYTHONPATH=. ./bin/start_runner.py
+```
+
+Upload a project to a new hypernode-vagrant and get a shell
+```bash
+PYTHONPATH=. ./bin/start_runner.py --project-dir=~/code/projects/hypernode-magerun
+```
+
+Upload a project to a new hypernode-vagrant and run a test command
+```bash
+PYTHONPATH=. ./bin/start_runner.py --project-dir=~/code/projects/hypernode-magerun --command-to-run='bash runtests.sh'
+```
+
+This gets you a test-prompt where you can change things in your project and then upload and run the tests again, or drop into a shell and change things in the Vagrant before running the tests again.
+```bash
+OK, but incomplete, skipped, or risky tests!
+Tests: 21, Assertions: 4, Skipped: 19.
+Looks like everything is OK
+
+Press enter to run the run the command again.
+S + Enter to get a shell.
+CTRL + C to stop the loop.
+> 
+```
+
+Getting a shell from the test-prompt
+```bash
+> s
+Getting remote shell on 127.0.0.1:2222
+Warning: Permanently added '[127.0.0.1]:2222' (ECDSA) to the list of known hosts.
+Welcome to Ubuntu 12.04.3 LTS (GNU/Linux 3.13.0-100-generic x86_64)
+
+ * Documentation:  https://help.ubuntu.com/
+New release '14.04.5 LTS' available.
+Run 'do-release-upgrade' to upgrade to it.
+
+Welcome to your Vagrant-built virtual machine.
+No mail.
+Last login: Sun Nov 13 20:18:24 2016 from 10.0.2.2
+app@358481-tmpj2b2jvo8-magweb-vgr:~$ 
+# Type 'exit' to return to the test-prompt
+```
+
+Run the tests again by pressing ENTER
+```bash
+> 
+Uploading project /home/vdloo/code/projects/hypernode-magerun to /data/web/public on the vagrant..
+Warning: Permanently added '[127.0.0.1]:2222' (ECDSA) to the list of known hosts.
+sending incremental file list
+composer.json
+...
+```
+
+Press CTRL + C to stop the loop and to destroy and clean up the Vagrant
+```bash
+> Interrupt received. Terminating loop.
+Destroying Vagrant
+[sudo] password for vdloo: 
+==> hypernode: vagrant.actions.vm.halt.force
+==> hypernode: Destroying VM and associated drives...
+==> hypernode: Updating /etc/hosts file on active guest machines...
+==> hypernode: Updating /etc/hosts file on host machine (password may be required)...
+Cleaning up temporary hypernode-vagrant directory
+```
+
+## Example
+
+Run the hypernode-vagrant-runner unit tests in a hypernode-vagrant started by the hypernode-vagrant-runner
+```bash
+git clone https://github.com/ByteInternet/hypernode-vagrant
+cd hypernode-vagrant/tools/hypernode-vagrant-runner
+chmod +x example_runtests.sh
+./example_runtests.sh
+```
+
+## Adding hypernode-vagrant-runner to your project
+
+Create a file (runtests.sh) with the following contents. Adjust the TEST_COMMAND and TEST_USER var to reflect your project.
+```bash
+#!/usr/bin/env bash
+set -e
+
+TEST_COMMAND="vendor/bin/phpunit --debug --stop-on-error --stop-on-failure"
+TEST_USER='app'
+
+HYPERNODE_VAGRANT_RUNNER_REPO="https://github.com/ByteInternet/hypernode-vagrant"
+HYPERNODE_VAGRANT_RUNNER_DIR='/tmp/hypernode-vagrant-runner'
+PROJECT_DIRECTORY="$(dirname "$(readlink -f "$0")")"
+
+
+if [ -d "$HYPERNODE_VAGRANT_RUNNER_DIR" ]; then
+    echo "Ensuring the hypernode-vagrant-runner is the latest version in $HYPERNODE_VAGRANT_RUNNER_DIR"
+    cd "$HYPERNODE_VAGRANT_RUNNER_DIR"
+    git clean -xfd
+    git pull origin master || /bin/true
+    git reset --hard origin/master
+    cd -
+else
+    echo "Creating a new checkout of hypernode-vagrant-runner in $HYPERNODE_VAGRANT_RUNNER_DIR"
+    git clone $HYPERNODE_VAGRANT_RUNNER_REPO $HYPERNODE_VAGRANT_RUNNER_DIR
+fi;
+
+chmod +x ${HYPERNODE_VAGRANT_RUNNER_DIR}/tools/hypernode-vagrant-runner/bin/start_runner.py
+PYTHONPATH=${HYPERNODE_VAGRANT_RUNNER_DIR}/tools/hypernode-vagrant-runner \
+    ${HYPERNODE_VAGRANT_RUNNER_DIR}/tools/hypernode-vagrant-runner/bin/start_runner.py \
+    --project-path="$PROJECT_DIRECTORY" \
+    --command-to-run="$TEST_COMMAND" \
+    --user="$TEST_USER" \
+    "$@"  # All other arguments. So you can run ./runtests.sh -1 for example
+```
+
+Make sure the script is executable:
+```bash
+chmod +x runtests.sh
+```
+
+You can now run loop the tests of your project in an ephemeral hypernode-vagrant by running the following command:
+```bash
+./runtest.sh
+...
+Time: 73 ms, Memory: 6.00MB
+
+OK, but incomplete, skipped, or risky tests!
+Tests: 21, Assertions: 4, Skipped: 19.
+Looks like everything is OK
+
+Press enter to run the run the command again.
+S + Enter to get a shell.
+CTRL + C to stop the loop.
+>
+```
+
+You can also just run it once and immediately destroy the Vagrant.
+If you want to run your tests in Jenkins this is probably what you are looking for.
+```bash
+./runtests.sh -1
+```
+
+## Development
+
+Note: This project has no python dependencies except for a Python (2 or 3) interpreter and the tooling to run the VM (Vagrant, Virtualbox, git, rsync). The reasoning behind that is that the benefit of having not to worry about libraries outweighs the cost of having some extra code that could be imported from modules like six. The goal is to make it easy to drop the runtests.sh script somewhere to combine hypernode-vagrant with projects without having to rewrite the same shell scripts to get the Vagrant set up every time.
+
+Running the unit tests
+```bash
+# Run the tests
+./runtests.sh -1
+
+# Run the tests in a loop (CTRL + C to stop)
+./runtests.sh
+```

tools/hypernode-vagrant-runner/bin/start_runner.py

@@ -0,0 +1,7 @@
+#!/usr/bin/env python
+from hypernode_vagrant_runner.commands import start_runner
+
+if __name__ == '__main__':
+    start_runner()
+else:
+    raise RuntimeError("This script is an entry point and can not be imported")

tools/hypernode-vagrant-runner/example_runtests.sh

@@ -0,0 +1,31 @@
+#!/usr/bin/env bash
+set -e 
+
+TEST_COMMAND="bash runtests.sh -1"  # Replace this with your tests entrypoint. 
+TEST_USER='app'  # Other options: root, vagrant (can sudo while app can not)
+
+HYPERNODE_VAGRANT_RUNNER_REPO="https://github.com/ByteInternet/hypernode-vagrant"
+HYPERNODE_VAGRANT_RUNNER_DIR='/tmp/hypernode-vagrant-runner'
+PROJECT_DIRECTORY="$(dirname "$(readlink -f "$0")")"
+
+
+if [ -d "$HYPERNODE_VAGRANT_RUNNER_DIR" ]; then
+    echo "Ensuring the hypernode-vagrant-runner is the latest version in $HYPERNODE_VAGRANT_RUNNER_DIR"
+    cd "$HYPERNODE_VAGRANT_RUNNER_DIR"
+    git clean -xfd
+    git pull origin master || /bin/true
+    git reset --hard origin/master
+    cd -
+else
+    echo "Creating a new checkout of hypernode-vagrant-runner in $HYPERNODE_VAGRANT_RUNNER_DIR"
+    git clone $HYPERNODE_VAGRANT_RUNNER_REPO $HYPERNODE_VAGRANT_RUNNER_DIR
+fi;
+
+chmod +x ${HYPERNODE_VAGRANT_RUNNER_DIR}/tools/hypernode-vagrant-runner/bin/start_runner.py
+PYTHONPATH=${HYPERNODE_VAGRANT_RUNNER_DIR}/tools/hypernode-vagrant-runner \
+    ${HYPERNODE_VAGRANT_RUNNER_DIR}/tools/hypernode-vagrant-runner/bin/start_runner.py \
+    --project-path="$PROJECT_DIRECTORY" \
+    --command-to-run="$TEST_COMMAND" \
+    --user="$TEST_USER" \
+    "$@"  # All other arguments. So you can run ./runtests.sh -1 or --help for example
+

tools/hypernode-vagrant-runner/hypernode_vagrant_runner/commands.py

@@ -0,0 +1,84 @@
+from argparse import ArgumentParser
+
+from hypernode_vagrant_runner.log import setup_logging
+from hypernode_vagrant_runner.runner import launch_runner
+from hypernode_vagrant_runner.settings import HYPERNODE_VAGRANT_PHP_VERSIONS, HYPERNODE_VAGRANT_DEFAULT_PHP_VERSION, \
+    HYPERNODE_VAGRANT_DEFAULT_USER, HYPERNODE_VAGRANT_USERS, UPLOAD_PATH
+
+
+def parse_arguments(parser):
+    """
+    Add default parser argument to parser, parse the arguments and set the
+    logging level.
+    :param obj parser: A parser object
+    :return obj args: The parsed arguments
+    """
+    parser.add_argument('--verbose', '-v', action='store_true')
+    args = parser.parse_args()
+    setup_logging(debug=args.verbose)
+    return args
+
+
+def parse_start_runner_arguments():
+    """
+    Parse the commandline options for starting the runner
+    :return obj args: parsed args
+    """
+    parser = ArgumentParser(
+        prog='hypernode-vagrant-runner',
+        description='Run a project inside a hypernode-vagrant'
+    )
+    parser.add_argument(
+        '--run-once', '-1',
+        action='store_true',
+        help='Run the provided hook once and destroy the machine. '
+             'Default persists the machine until CTRL + C'
+    )
+    parser.add_argument(
+        '--project-path',
+        help='Path to upload to the {} directory. If specified the command '
+             'wil be run in this directory. '
+             'Example: ~/code/projects/your_shop'.format(UPLOAD_PATH)
+    )
+    parser.add_argument(
+        '--command-to-run', '-c',
+        help='The command to run in the uploaded directory. '
+             'Example: -c "sh runtests.sh"'
+    )
+    parser.add_argument(
+        '--pre-existing-vagrant-path', '-p',
+        help='Path to an existing hypernode-vagrant checkout. '
+             'By default a new checkout in a temporary directory '
+             'is used'
+    )
+    parser.add_argument(
+        '--php',
+        help='Specify a PHP version. Default is '
+             '{}'.format(HYPERNODE_VAGRANT_DEFAULT_PHP_VERSION),
+        choices=HYPERNODE_VAGRANT_PHP_VERSIONS,
+        default=HYPERNODE_VAGRANT_DEFAULT_PHP_VERSION
+    )
+    parser.add_argument(
+        '--user',
+        help='The SSH user to run the command as. Default is '
+             '{}'.format(HYPERNODE_VAGRANT_DEFAULT_USER),
+        choices=HYPERNODE_VAGRANT_USERS,
+        default=HYPERNODE_VAGRANT_DEFAULT_USER
+    )
+    return parse_arguments(parser)
+
+
+def start_runner():
+    """
+    Start a hypernode vagrant and run the provided hook
+    :return None:
+    """
+    args = parse_start_runner_arguments()
+    launch_runner(
+        project_path=args.project_path,
+        command_to_run=args.command_to_run,
+        run_once=args.run_once,
+        directory=args.pre_existing_vagrant_path,
+        php_version=args.php,
+        ssh_user=args.user
+    )

tools/hypernode-vagrant-runner/hypernode_vagrant_runner/log.py

@@ -0,0 +1,15 @@
+from logging import getLogger, DEBUG, INFO, StreamHandler
+from sys import stdout
+
+
+def setup_logging(debug=False):
+    """
+    Set up the logging for hypernode_vagrant_runner
+    :param bool debug: Log DEBUG level to console (INFO is default)
+    :return obj logger: The logger object
+    """
+    logger = getLogger('hypernode_vagrant_runner')
+    logger.setLevel(DEBUG if debug else INFO)
+    console_handler = StreamHandler(stdout)
+    logger.addHandler(console_handler)
+    return logger