Add macOS support; input validation; an example

Makefile

@@ -7,9 +7,9 @@ build_dir=build/pkg
 dist_dir=build/dist
 
 # Variables that are replaced in build time
-bin_path=/usr/bin
-lib_path=/usr/lib/ansible-bundler
-etc_path=/etc/ansible-bundler
+bin_path=.
+lib_path=../lib/ansible-bundler
+etc_path=../../etc/ansible-bundler
 version=$(shell cat VERSION)
 
 # Package variables
@@ -32,7 +32,13 @@ package:
 	cp -r app/bin $(build_dir)/usr
 	cp -r app/etc $(build_dir)/etc/ansible-bundler
 	cp -r app/lib $(build_dir)/usr/lib/ansible-bundler
-	sed -i'' \
+	UNAME=$$(uname); \
+	if [ "$$UNAME" == 'Darwin' ]; then \
+		SED_BINARY=$$(which gsed); \
+	else \
+		SED_BINARY=$$(which sed); \
+	fi; \
+	$$SED_BINARY -i'' \
 		-e 's#LIB_PATH=.*#LIB_PATH=$(lib_path)#' \
 		-e 's#ETC_PATH=.*#ETC_PATH=$(etc_path)#' \
 		-e 's#VERSION=.*#VERSION=$(version)#' \

README.md

@@ -128,3 +128,19 @@ Please make sure to update tests as appropriate. For more information, please re
 
 This project is licensed under the BSD 3-Clause License - see the [LICENSE.md](LICENSE.md) file for
 details.
+
+## Example
+
+Before reading this, be sure to follow the instructions  
+above to build the package.  
+
+```shell
+# Starting from the root of this repository, run this command:
+cd build/pkg/usr/bin 
+
+# Employ the basic playbook example
+./bundle-playbook -f ../../../../examples/basic.yaml
+
+# Run the playbook
+../../../../examples/basic.run -e example=VALUE
+```

app/bin/bundle-playbook

@@ -194,20 +194,20 @@ copy_playbook() {
 	shift 4; local extra_deps=("${@}")
 
 	echo "Adding playbook..."
-	cp -L --preserve=timestamps "$playbook_file" "$tmpdir/playbook.yml"
+	cp -L -p "$playbook_file" "$tmpdir/playbook.yml"
 	if [ -d "$playbook_path/roles" ]; then
 		echo "Adding roles..."
-		cp -Lr --preserve=timestamps "$playbook_path/roles" "$tmpdir"
+		cp -Lrp "$playbook_path/roles" "$tmpdir"
 	fi
 
 	if [ -n "$requirements_file" ]; then
 		echo "Adding requirements..."
-		cp -L --preserve=timestamps "$requirements_file" "$tmpdir/requirements.yml"
+		cp -L -p "$requirements_file" "$tmpdir/requirements.yml"
 	fi
 
 	if [ -n "$vars_file" ]; then
 		echo "Adding vars..."
-		cp -L --preserve=timestamps "$vars_file" "$tmpdir/vars.yml"
+		cp -L -p "$vars_file" "$tmpdir/vars.yml"
 	fi
 
 	if [ ${#extra_deps[@]} -gt 0 ]; then
@@ -218,7 +218,7 @@ copy_playbook() {
 	fi
 
 	echo "Adding ansible config..."
-	cp -L --preserve=timestamps "$ETC_PATH/ansible.cfg" "$tmpdir"
+	cp -L -p "$ETC_PATH/ansible.cfg" "$tmpdir"
 }
 
 add_python_requirements() {
@@ -290,20 +290,34 @@ install_roles() {
 
 add_entrypoint() {
 	echo "Adding entrypoint..."
-	cp -L --preserve=timestamps "$LIB_PATH/run-playbook.sh" "$tmpdir"
-	chmod 0755 "$tmpdir/run-playbook.sh"
+    if [ -e "$LIB_PATH/run-playbook.sh" ]; then
+        cp -L -p "$LIB_PATH/run-playbook.sh" "$tmpdir"
+        chmod 0755 "$tmpdir/run-playbook.sh"
+    else
+        echo "File not found: $LIB_PATH/run-playbook.sh"
+    fi
 }
 
 compress_output() {
-	local output_file=$1
+    local output_file=$1
 
-	echo "Packaging files to the output..."
+    echo "Packaging files to the output..."
 
-	# First add the header to the final script
-	cat "$LIB_PATH/bin-header.sh" > "$output_file"
+    # First add the header to the final script
+    if [ -e "$LIB_PATH/bin-header.sh" ]; then
+        cat "$LIB_PATH/bin-header.sh" > "$output_file"
+    else
+        echo "File not found: $LIB_PATH/bin-header.sh"
+    fi
 
+	SED_BINARY=''
 	# Do some build-time metadata insertion
-	sed -i'' \
+	if [[ "$(uname)" == 'Darwin' ]]; then 
+		SED_BINARY=`which gsed`
+	else 
+		SED_BINARY=`which sed`
+	fi
+	$SED_BINARY -i'' \
 		-e "s/UNCOMPRESS_SKIP=.*/UNCOMPRESS_SKIP=$(( $(wc -l < "$output_file") + 1 ))/" \
 		-e "s/\$VERSION/$VERSION/g" \
 		"$output_file"

app/lib/bin-header.sh

@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/usr/bin/env bash
 #
 # This is a packaged ansible playbook file using Ansible Bundler v$VERSION.
 # You can run this with --debug to show more information about the process.

app/lib/run-playbook.sh

@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/usr/bin/env bash
 #
 # This is the entry point for the playbook bundle. It has a hard dependency on Python. It will try
 # to look for an already existing installation of Ansible, and will try to install it if not found.
@@ -11,7 +11,11 @@ main() {
 	export BASEDIR=${BASEDIR:-.}
 
 	# Ensure we have HOME defined, otherwise set it manually
-	test -z "$HOME" && export HOME; HOME="$(getent passwd "$(id -un)" | cut -d: -f6)"
+	if [[ "$(uname)" == 'Darwin' ]]; then
+ 	   test -z "$HOME" && export HOME; HOME="$(dscl . -read /Users/$(id -un) NFSHomeDirectory | awk -F': ' '{print $2}')"
+	else
+  	  test -z "$HOME" && export HOME; HOME="$(getent passwd "$(id -un)" | cut -d: -f6)"
+	fi
 
 	export PIP_ROOT_PATH; PIP_ROOT_PATH="$(realpath "${BASEDIR}/python-deps")"
 	export PATH="${PIP_ROOT_PATH}/usr/bin:${PIP_ROOT_PATH}${HOME}/.local/bin:${PATH}"

examples/basic.yaml

@@ -0,0 +1,12 @@
+---
+
+- hosts: all
+
+  tasks:
+    - name: basic-example
+      debug:
+        msg: You are running a basic example
+
+    - name: Print extra variable 'example'
+      debug:
+        msg: "Example value is {{ example }}"