copy-in: generic command to copy things in a pot

    copy-in: first implementation
    copy-in: adjust verbosity support
    Add copy-in command to pot
    Add autocompletion
    Add tests
    add-file: mark as deprecated

Author: pizzamig

CHANGELOG.md

@@ -9,12 +9,16 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - update-config: new command that will update a pot configuration
 - execute: an orchestration oriented command that imports and automatically set several settings on a pot
 - prepare: new command, taking the place of execute
+- copy-in: new command, to copy files or directory inside a pot (generalized replacement of add-file)
 
 ### Changed
 - export-ports: removed -S for static port export
 - export-ports: add the ability to associate any host port to a pot port to be exported using pot_port:host_port format
 - execute: an alias for prepare
 
+### Deprecated
+- add-file: deprecated, replaced by the more general new copy-in command
+
 ## [0.6.1] 2019-06-25
 ### Fixed
 - init: make pf.conf more robust

bin/pot

@@ -90,6 +90,7 @@ Commands:
 	promote -- Promote a cloned pot -- DEPRECATED
 	rename -- Rename a pot
 	destroy -- Destroy a pot
+	copy-in -- Copy a file or a directory into a pot
 	add-file -- Add a file to a pot
 	add-fscomp -- Add a fs component or a directory to a pot
 	add-dep -- Add a dependency
@@ -158,6 +159,7 @@ case "${CMD}" in
 	list|info|ps|top|\
 	init|de-init|vnet-start|\
 	create-base|create-fscomp|create|create-dns|\
+	copy-in|\
 	add-file|add-fscomp|destroy|add-dep|set-rss|set-cmd|\
 	export|import|prepare|\
 	export-ports|set-attribute|get-attribute|\

share/pot/add-file.sh

@@ -59,6 +59,12 @@ pot-add-file()
 		esac
 	done
 
+	echo '##############################'
+	echo '#   add-file is deprecated   #'
+	echo '##############################'
+	echo '# Please use copy-in instead #'
+	echo '##############################'
+
 	if [ -z "$_pname" ]; then
 		_error "A pot name is mandatory"
 		add-file-help

share/pot/copy-in.sh

@@ -0,0 +1,115 @@
+#!/bin/sh
+:
+
+# shellcheck disable=SC2039
+copy-in-help()
+{
+	echo "pot copy-in [-hv] -p pot -s source -d destination"
+	echo '  -h print this help'
+	echo '  -v verbose'
+	echo '  -p pot : the working pot'
+	echo '  -s source : the file to be added component to be added'
+	echo '  -d destination : the final location inside the pot'
+}
+
+# $1 source
+_source_validation()
+{
+	# shellcheck disable=SC2039
+	local _pname _source _destination
+	_source="$1"
+	if [ -f "$_source" ] || [ -d "$_source" ]; then
+		if [ -r "$_source" ]; then
+			return 0 # true
+		else
+			_error "$_source not readable"
+		fi
+	else
+		_error "$_source not valid"
+		return 1 # false
+	fi
+}
+
+# shellcheck disable=SC2039
+pot-copy-in()
+{
+	local _pname _source _destination _to_be_umount
+	OPTIND=1
+	_pname=
+	_destination=
+	while getopts "hvs:d:p:" _o ; do
+		case "$_o" in
+		h)
+			copy-in-help
+			${EXIT} 0
+			;;
+		v)
+			_POT_VERBOSITY=$(( _POT_VERBOSITY + 1))
+			;;
+		s)
+			_source="$OPTARG"
+			;;
+		p)
+			_pname="$OPTARG"
+			;;
+		d)
+			_destination="$OPTARG"
+			;;
+		*)
+			copy-in-help
+			${EXIT} 1
+			;;
+		esac
+	done
+
+	if [ -z "$_pname" ]; then
+		_error "A pot name is mandatory"
+		copy-in-help
+		${EXIT} 1
+	fi
+	if [ -z "$_source" ]; then
+		_error "A source is mandatory"
+		copy-in-help
+		${EXIT} 1
+	fi
+	if [ -z "$_destination" ]; then
+		_error "A destination is mandatory"
+		copy-in-help
+		${EXIT} 1
+	fi
+	if ! _is_absolute_path "$_destination" ; then
+		_error "The destination has to be an absolute pathname"
+		${EXIT} 1
+	fi
+	_destination="${_destination#/}"
+
+	if ! _is_pot "$_pname" ; then
+		_error "pot $_pname is not valid"
+		copy-in-help
+		${EXIT} 1
+	fi
+	if ! _is_uid0 ; then
+		${EXIT} 1
+	fi
+	if ! _source_validation "$_source" ; then
+		copy-in-help
+		${EXIT} 1
+	fi
+	if ! _is_pot_running "$_pname" ; then 
+		_pot_mount "$_pname"
+		_to_be_umount=1
+	fi
+	if _is_verbose ; then
+		_cp_opt="-va"
+	else
+		_cp_opt="-a"
+	fi
+	if cp "$_cp_opt" "$_source" "${POT_FS_ROOT}/jails/$_pname/m/$_destination" ; then
+		_debug "Source $_source copied in the pot $_pname"
+	else
+		_error "Source $_source NOT copied because of an error"
+	fi
+	if [ "$_to_be_umount" = "1" ]; then
+		_pot_umount "$_pname"
+	fi
+}

share/zsh/site-functions/_pot

@@ -154,6 +154,14 @@ _pot() {
 						'-f[fscomp name]:fscomp name:_pot_fscomps' \
 						'-r[Recursive destroying]'
 					;;
+				copy-in)
+					_arguments \
+						'-h[Show help]' \
+						'-v[Verbose output]' \
+						'-p[pot name]:pot name:_pot_pots' \
+						'-s[source]:source:_normal' \
+						'-d[destination]:destination:_normal'
+					;;
 				add-file)
 					_arguments \
 						'-h[Show help]' \
@@ -324,6 +332,7 @@ _pot_cmds() {
 	'promote:Promote a cloned pot -- DEPRECATED'
 	'rename:Rename a pot'
 	'destroy:Destroy a pot'
+	'copy-in:Copy a file or a directory into a pot'
 	'add-file:Add a file to a pot'
 	'add-fscomp:Add a fs component or a directory to a pot'
 	'add-dep:Add a dependency to a pot'