Add Atom build tests and README

This commit is contained in:
cryobry
2020-05-10 13:04:20 -04:00
parent e617825cfb
commit 6bb5e9346b
4 changed files with 51 additions and 1 deletions

5
.atom-build.yml Normal file
View File

@@ -0,0 +1,5 @@
cmd: './podmanRun -o "--name=bash_{FILE_ACTIVE_NAME_BASE} -v={FILE_ACTIVE_PATH}:{FILE_ACTIVE_PATH}:z -w={FILE_ACTIVE_PATH} ubuntu:latest" test.sh "hello world!"'
name: 'Test podmanRun'
targets:
Test podmanRun w/ debug:
cmd: './podmanRun --debug -o "--name=bash_{FILE_ACTIVE_NAME_BASE} -v={FILE_ACTIVE_PATH}:{FILE_ACTIVE_PATH}:z -w={FILE_ACTIVE_PATH} ubuntu:latest" test.sh "hello world!"'

38
README.md Normal file
View File

@@ -0,0 +1,38 @@
```
USAGE
podmanRun [-m MODE] [-o OPTIONS] [COMMANDS [ARGS]...] [--help] [--debug]
COMMANDS
COMMANDS to run in the container
OPTIONS
--mode, -m MODE
1. recreate (remove container if it already exists and create a new one)
2. persistent (reuse existing container if it exists)
--options, -o OPTIONS
OPTIONS to pass to podman run/exec
Can be passed multiple times to concatenate
Will be split on whitespace
Final option should be the name of the container image
--debug, -d
Print debugging
--help, -h
Print this help message and exit
EXAMPLES
Note: IDE examples are using Atom Build package placeholders.
Run an ephemeral PHP webserver container using the current directory as webroot:
podmanRun -o "-p=8000:80 --name=php_script -v=$PWD:/var/www/html:z php:7.3-apache"
Run an ephemeral PHP webserver container using the current directory as webroot using IDE:
podmanRun -o "-p=8000:80 --name=php_{FILE_ACTIVE_NAME_BASE} \
-v={FILE_ACTIVE_PATH}:/var/www/html:z php:7.3-apache"
Run an ephemeral bash script:
podmanRun -o "--name=bash_script -v=$PWD:$PWD:z -w=$PWD debian:testing" ./script.sh
Run an ephemeral bash script using IDE:
podmanRun -o "--name=bash_{FILE_ACTIVE_NAME_BASE}" \
-o "-v={FILE_ACTIVE_PATH}:{FILE_ACTIVE_PATH}:z"
-o "-w={FILE_ACTIVE_PATH}" \
-o "debian:testing" \
{FILE_ACTIVE} arg1 arg2
```

View File

@@ -31,7 +31,7 @@ podmanRun() {
if [[ -z $_debug ]]; then if [[ -z $_debug ]]; then
cat <<-'EOF' cat <<-'EOF'
USAGE USAGE
podmanRun -m MODE -o OPTIONS [COMMANDS [ARGS]...] [--help] [--debug] podmanRun [-m MODE] [-o OPTIONS] [COMMANDS [ARGS]...] [--help] [--debug]
COMMANDS COMMANDS
COMMANDS to run in the container COMMANDS to run in the container
@@ -43,6 +43,7 @@ OPTIONS
--options, -o OPTIONS --options, -o OPTIONS
OPTIONS to pass to podman run/exec OPTIONS to pass to podman run/exec
Can be passed multiple times to concatenate Can be passed multiple times to concatenate
Will be split on whitespace
Final option should be the name of the container image Final option should be the name of the container image
--debug, -d --debug, -d
Print debugging Print debugging
@@ -54,11 +55,14 @@ EXAMPLES
Run an ephemeral PHP webserver container using the current directory as webroot: Run an ephemeral PHP webserver container using the current directory as webroot:
podmanRun -o "-p=8000:80 --name=php_script -v=$PWD:/var/www/html:z php:7.3-apache" podmanRun -o "-p=8000:80 --name=php_script -v=$PWD:/var/www/html:z php:7.3-apache"
Run an ephemeral PHP webserver container using the current directory as webroot using IDE: Run an ephemeral PHP webserver container using the current directory as webroot using IDE:
podmanRun -o "-p=8000:80 --name=php_{FILE_ACTIVE_NAME_BASE} \ podmanRun -o "-p=8000:80 --name=php_{FILE_ACTIVE_NAME_BASE} \
-v={FILE_ACTIVE_PATH}:/var/www/html:z php:7.3-apache" -v={FILE_ACTIVE_PATH}:/var/www/html:z php:7.3-apache"
Run an ephemeral bash script: Run an ephemeral bash script:
podmanRun -o "--name=bash_script -v=$PWD:$PWD:z -w=$PWD debian:testing" ./script.sh podmanRun -o "--name=bash_script -v=$PWD:$PWD:z -w=$PWD debian:testing" ./script.sh
Run an ephemeral bash script using IDE: Run an ephemeral bash script using IDE:
podmanRun -o "--name=bash_{FILE_ACTIVE_NAME_BASE}" \ podmanRun -o "--name=bash_{FILE_ACTIVE_NAME_BASE}" \
-o "-v={FILE_ACTIVE_PATH}:{FILE_ACTIVE_PATH}:z" -o "-v={FILE_ACTIVE_PATH}:{FILE_ACTIVE_PATH}:z"

3
test.sh Executable file
View File

@@ -0,0 +1,3 @@
#!/usr/bin/env bash
echo "$@"