Multi pr

.envrc

@@ -0,0 +1,2 @@
+export VIRTUAL_ENV=./venv
+layout python-venv python3.7

.github/workflows/python-package.yml

@@ -0,0 +1,43 @@
+name: Python package
+
+on: [push]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [3.7, 3.8]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v1
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install docopt clint requests flake8 pytest pytest_mock mock pytest-cov pylint pytest-xdist
+    - name: Lint with flake8
+      run: |
+        # stop the build if there are Python syntax errors or undefined names
+        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+    - name: Test with pytest
+      run: |
+        pytest
+    - name: Generate coverage report
+      run: |
+        pytest --cov=mech --cov-report=xml
+    - name: Upload coverage to Codecov
+      uses: codecov/codecov-action@v1
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }}
+        file: ./coverage.xml
+        flags: unittests
+        name: codecov-umbrella
+        yml: ./codecov.yml
+        fail_ci_if_error: true

.gitignore

@@ -1,8 +1,12 @@
 .DS_Store
+cov_html/
+.coverage
 *.pyc
 .idea/
 build/
 dist/
 mech.egg-info/
 .mech/
 Mechfile
+.*swp
+venv/

CONTRIBUTING.md

@@ -0,0 +1,81 @@
+# Contributing to mech 
+
+Anyone can open a pull request to help expand/enhance the functionality are essential to mech's growth.
+
+This guide should help get you started contributing to mech.
+
+
+## Dev Setup
+
+```sh
+# Clone the repo
+git clone [email protected]:mkinney/mech.git
+
+# Change into that cloned directory
+cd mech
+
+# If virtualenv is not installed:
+sudo apt-get install virtualenv
+
+# Create a virtualenv
+virtualenv -p python3 venv
+
+# Activate the python virtual environment
+source venv/bin/activate
+
+# consider installing/using direnv (there is a .envrc in this repo)
+# may need to run "direnv allow"
+
+# install mech from this code
+python setup.py install
+
+# if doing development
+pip install docopt clint requests flake8 pytest pytest_mock mock pytest-cov pylint pytest-xdist pytest-timeout
+
+# also optional
+pip install autopep8
+# use like this: autopep8 --in-place --aggressive --aggressive somefile.py
+
+# Configure git to use pre-commit hook
+flake8 --install-hook git
+
+# for running unit tests:
+pytest
+
+# for code coverage
+pytest --cov mech
+
+# to see what lines are not covered
+pytest --cov-report term-missing --cov mech
+
+# or to get a nice html output
+pytest --cov-report html:cov_html --cov=mech
+# then open cov_html/index.html
+# or if you want all coverage html report
+pytest --cov-report html:cov_html --cov=mech -m"int or not int"
+
+# if you want to do a quick-ish (takes 1.5 minutes) smoke test
+# this runs thru most basic functionality of mech
+./smoke_test
+
+# to see the slowest unit tests
+pytest --durations=0
+
+# if you have a unittest that is taking too long, but cannot find out which one
+# add "timeout = 10" (for 10 seconds)
+
+# for testing/validation, we have also some integration tests
+# NOTE: Can take 5+ minutes.
+# cd tests/int (see "all" file)
+# You can run the int tests by themselves directly if you change
+# into the tests/int directory.
+# Or, you can run them from the main project directory like this:
+pytest -m"int"
+
+# To run all tests (with verbose output and show local variables):
+pytest -m"int or not int" -vv -l
+# or just run "./full_test"
+
+# Or, just one run int test like this (with verbose and show local variables):
+pytest -m"int" -k"provision" -v -l
+```

README.md

@@ -1,7 +1,10 @@
 # mech
 
-I made this because I don't like VirtualBox and I wanted to use vagrant
-with VMWare Fusion but was too cheap to buy the Vagrant plugin.
+![Python package](https://github.com/mkinney/mech/workflows/Python%20package/badge.svg?branch=multi-pr)
+[![codecov](https://codecov.io/gh/mkinney/mech/branch/multi-pr/graph/badge.svg)](https://codecov.io/gh/mkinney/mech)
+
+One of the authors made this because they don't like VirtualBox and wanted to use vagrant
+with VMmare Fusion but was too cheap to buy the Vagrant plugin.
 
 https://blog.kchung.co/mech-vagrant-with-vmware-integration-for-free/
 
@@ -16,44 +19,64 @@ Options:
     --debug                          Show debug messages.
 
 Common commands:
-    (list|ls)         lists all available boxes
-    init              initializes a new Mech environment by creating a Mechfile
-    destroy           stops and deletes all traces of the Mech machine
-    (up|start)        starts and provisions the Mech environment
-    (down|stop|halt)  stops the Mech machine
-    suspend           suspends the machine
-    pause             pauses the Mech machine
-    ssh               connects to machine via SSH
-    ssh-config        outputs OpenSSH valid configuration to connect to the machine
-    scp               copies files to and from the machine via SCP
-    ip                outputs ip of the Mech machine
-    box               manages boxes: installation, removal, etc.
-    global-status     outputs status Mech environments for this user
-    status            outputs status of the Mech machine
-    ps                list running processes in Guest OS
-    provision         provisions the Mech machine
-    reload            restarts Mech machine, loads new Mechfile configuration
-    resume            resume a paused/suspended Mech machine
-    snapshot          manages snapshots: saving, restoring, etc.
-    port              displays information about guest port mappings
-    push              deploys code in this environment to a configured destination
+        box               manages boxes: add, list remove, etc.
+        destroy           stops and deletes all traces of the instances
+        (down|stop|halt)  stops the instances
+        global-status     outputs status of all virutal machines on this host
+        init              initializes a new Mech environment by creating a Mechfile
+        ip                outputs ip of an instance
+        (list|ls)         lists all available boxes
+        pause             pauses the instances
+        port              displays information about guest port mappings
+        provision         provisions the Mech machine
+        ps                list running processes for an instance
+        reload            restarts Mech machine, loads new Mechfile configuration
+        resume            resume a paused/suspended Mech machine
+        scp               copies files to/from the machine via SCP
+        snapshot          manages snapshots: save, list, remove, etc.
+        ssh               connects to an instance via SSH
+        ssh-config        outputs OpenSSH valid configuration to connect to the instances
+        status            outputs status of the instances
+        suspend           suspends the instances
+        (up|start)        starts instances (aka virtual machines)
+        upgrade           upgrade the instances
 
 For help on any individual command run `mech <command> -h`
 
 Example:
 
+    mech up --help
+
+% mech up --help
+Starts and provisions the mech environment.
+
+Usage: mech up [options] [<instance>]
+
+Options:
+	--disable-provisioning       Do not provision
+	--disable-shared-folders     Do not share folders with VM
+	--gui                        Start GUI
+	--memsize 1024               Specify the size of memory for VM
+	--no-cache                   Do not save the downloaded box
+	--no-nat                     Do not use NAT network (i.e., bridged)
+	--numvcpus 1                 Specify the number of vcpus for VM
+    -h, --help                       Print this help
+    -r, --remove-vagrant             Remove vagrant user
+
+Example using mech:
+
+
 Initializing and using a machine from HashiCorp's Vagrant Cloud:
 
-    mech init bento/ubuntu-14.04
+    mech init bento/ubuntu-18.04
     mech up
     mech ssh
 ```
 
 `mech init` can be used to pull a box file which will be installed and
 generate a Mechfile in the current directory. You can also pull boxes
 from Vagrant Cloud with `mech init freebsd/FreeBSD-11.1-RELEASE`.
-Barring that, `mech up <name>` can also be used to specify a vmx file
-to start.
+See the `mech up -h` page for more information.
 
 # Install
 
@@ -63,6 +86,11 @@ or for the latest:
 
 `pip install -U git+https://github.com/mechboxes/mech.git`
 
+There are some open PRs that have yet to be merged. Until they are, you may consider
+installing from:
+
+`pip install -U git+https://github.com/mkinney/mech.git@multi-pr#egg=mech`
+
 # Shared Folders
 
 If the box you init was created properly, you will be able to access
@@ -85,3 +113,57 @@ or
 ```bash
 vmhgfs-fuse .host:/mech /mnt/hgfs
 ```
+
+# Changing vcpus and/or memory size
+
+If you do not specify how many vcpus or memory, then the values
+in the .box file will be used. To override, use appropriate settings:
+
+`mech up --numvcpus 2 --memsize 1024`
+
+
+# Want zsh completion for commands/options (aka "tab completion")?
+1. add these lines to ~/.zshrc
+
+```bash
+# folder of all of your autocomplete functions
+fpath=($HOME/.zsh-completions $fpath)
+# enable autocomplete function
+autoload -U compinit
+compinit
+```
+
+2. Copy script to something in fpath (Note: Run `echo $fpath` to show value.)
+
+```bash
+cp _mech ~/.zsh-completions/
+```
+
+3. Reload zsh
+
+```bash
+exec zsh
+```
+
+4. Try it out by typing `mech <tab>`. It should show the options available.
+
+# Want bash completion for commands/options (aka "tab completion")?
+1. add these lines to ~/.bash_profile
+
+```bash
+[ -f /usr/local/etc/bash_completion ] && . /usr/local/etc/bash_completion
+```
+
+2. Copy script to path above
+
+```bash
+cp mech_completion.sh /usr/local/etc/bash_completion/
+```
+
+3. Reload .bash_profile
+
+```bash
+source ~/.bash_profile
+```
+
+4. Try it out by typing `mech <tab>`. It should show the options available.