forked from ungleich-public/cdist
		
	[type/__uci_commit] Delete type
This commit is contained in:
		
					parent
					
						
							
								e264fb004f
							
						
					
				
			
			
				commit
				
					
						dfe9e08c28
					
				
			
		
					 5 changed files with 0 additions and 161 deletions
				
			
		| 
						 | 
					@ -58,13 +58,11 @@ EXAMPLES
 | 
				
			||||||
        --value '1.openwrt.pool.ntp.org' \
 | 
					        --value '1.openwrt.pool.ntp.org' \
 | 
				
			||||||
        --value '2.openwrt.pool.ntp.org' \
 | 
					        --value '2.openwrt.pool.ntp.org' \
 | 
				
			||||||
        --value '3.openwrt.pool.ntp.org'
 | 
					        --value '3.openwrt.pool.ntp.org'
 | 
				
			||||||
    export require=__uci_commit/ntp
 | 
					 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
SEE ALSO
 | 
					SEE ALSO
 | 
				
			||||||
--------
 | 
					--------
 | 
				
			||||||
- https://openwrt.org/docs/guide-user/base-system/uci
 | 
					- https://openwrt.org/docs/guide-user/base-system/uci
 | 
				
			||||||
- :strong:`cdist-type__uci_commit`\ (7)
 | 
					 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
AUTHORS
 | 
					AUTHORS
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
| 
						 | 
					@ -18,15 +18,9 @@
 | 
				
			||||||
# along with cdist. If not, see <http://www.gnu.org/licenses/>.
 | 
					# along with cdist. If not, see <http://www.gnu.org/licenses/>.
 | 
				
			||||||
#
 | 
					#
 | 
				
			||||||
 | 
					
 | 
				
			||||||
# shellcheck source=files/functions.sh
 | 
					 | 
				
			||||||
. "${__type:?}/files/functions.sh"
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
os=$(cat "${__global:?}/explorer/os")
 | 
					os=$(cat "${__global:?}/explorer/os")
 | 
				
			||||||
 | 
					
 | 
				
			||||||
state_is=$(cat "${__object:?}/explorer/state")
 | 
					 | 
				
			||||||
state_should=$(cat "${__object:?}/parameter/state")
 | 
					state_should=$(cat "${__object:?}/parameter/state")
 | 
				
			||||||
transaction_name=$(cat "${__object:?}/parameter/transaction")
 | 
					 | 
				
			||||||
 | 
					
 | 
				
			||||||
case ${os}
 | 
					case ${os}
 | 
				
			||||||
in
 | 
					in
 | 
				
			||||||
| 
						 | 
					@ -40,8 +34,6 @@ in
 | 
				
			||||||
		;;
 | 
							;;
 | 
				
			||||||
esac
 | 
					esac
 | 
				
			||||||
 | 
					
 | 
				
			||||||
changes_required=false
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
case ${state_should}
 | 
					case ${state_should}
 | 
				
			||||||
in
 | 
					in
 | 
				
			||||||
	(present)
 | 
						(present)
 | 
				
			||||||
| 
						 | 
					@ -49,21 +41,11 @@ in
 | 
				
			||||||
			echo 'The parameter --value is required.' >&2
 | 
								echo 'The parameter --value is required.' >&2
 | 
				
			||||||
			exit 1
 | 
								exit 1
 | 
				
			||||||
		}
 | 
							}
 | 
				
			||||||
 | 
					 | 
				
			||||||
		# NOTE: order is ignored so rearranged is also fine.
 | 
					 | 
				
			||||||
		in_list "${state_is}" 'present' 'rearranged' || changes_required=true
 | 
					 | 
				
			||||||
		;;
 | 
							;;
 | 
				
			||||||
	(absent)
 | 
						(absent)
 | 
				
			||||||
		in_list "${state_is}" 'absent' || changes_required=true
 | 
					 | 
				
			||||||
		;;
 | 
							;;
 | 
				
			||||||
	(*)
 | 
						(*)
 | 
				
			||||||
		printf 'Invalid --state: %s\n' "${state_should}" >&2
 | 
							printf 'Invalid --state: %s\n' "${state_should}" >&2
 | 
				
			||||||
		exit 1
 | 
							exit 1
 | 
				
			||||||
		;;
 | 
							;;
 | 
				
			||||||
esac
 | 
					esac
 | 
				
			||||||
 | 
					 | 
				
			||||||
if ${changes_required}
 | 
					 | 
				
			||||||
then
 | 
					 | 
				
			||||||
	# Make sure the changes are being committed
 | 
					 | 
				
			||||||
	require=${__object_name:?} __uci_commit "${transaction_name}"
 | 
					 | 
				
			||||||
fi
 | 
					 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
| 
						 | 
					@ -1,81 +0,0 @@
 | 
				
			||||||
#!/bin/sh -e
 | 
					 | 
				
			||||||
#
 | 
					 | 
				
			||||||
# 2020 Dennis Camera (dennis.camera@ssrq-sds-fds.ch)
 | 
					 | 
				
			||||||
#
 | 
					 | 
				
			||||||
# This file is part of cdist.
 | 
					 | 
				
			||||||
#
 | 
					 | 
				
			||||||
# cdist is free software: you can redistribute it and/or modify
 | 
					 | 
				
			||||||
# it under the terms of the GNU General Public License as published by
 | 
					 | 
				
			||||||
# the Free Software Foundation, either version 3 of the License, or
 | 
					 | 
				
			||||||
# (at your option) any later version.
 | 
					 | 
				
			||||||
#
 | 
					 | 
				
			||||||
# cdist is distributed in the hope that it will be useful,
 | 
					 | 
				
			||||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 | 
					 | 
				
			||||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 | 
					 | 
				
			||||||
# GNU General Public License for more details.
 | 
					 | 
				
			||||||
#
 | 
					 | 
				
			||||||
# You should have received a copy of the GNU General Public License
 | 
					 | 
				
			||||||
# along with cdist. If not, see <http://www.gnu.org/licenses/>.
 | 
					 | 
				
			||||||
#
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
transaction_name=${__object_id:?}
 | 
					 | 
				
			||||||
batchfile="${__global:?}/tmp/__uci/${transaction_name}.txt"
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
test -s "${batchfile}" || exit 0
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
printf 'commit transaction %s\n' "${transaction_name}" >>"${__messages_out:?}"
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
# NOTE: Uncommited changes are checked in code-remote instead of in an explorer
 | 
					 | 
				
			||||||
#       because in cdist there is no interlocking between explorers and code
 | 
					 | 
				
			||||||
#       execution.
 | 
					 | 
				
			||||||
#       Checking for uncommited changes in an explorer leaves a time slot in
 | 
					 | 
				
			||||||
#       which changes made are not detected by the code.
 | 
					 | 
				
			||||||
#       Furthermore an explorer running concurrently with another transactions
 | 
					 | 
				
			||||||
#       code-remote could lead to a false positive.
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
cat <<CODE
 | 
					 | 
				
			||||||
changes=\$(uci changes)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
if test -n "\${changes}"
 | 
					 | 
				
			||||||
then
 | 
					 | 
				
			||||||
	echo 'Uncommited UCI changes were found on the target:'
 | 
					 | 
				
			||||||
	printf '%s\n\n' "\${changes}"
 | 
					 | 
				
			||||||
	echo 'This can be caused by manual changes or due to a previous failed run.'
 | 
					 | 
				
			||||||
	echo 'Please investigate the situation, revert or commit the changes, and try again.'
 | 
					 | 
				
			||||||
	exit 1
 | 
					 | 
				
			||||||
fi >&2
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
check_errors() {
 | 
					 | 
				
			||||||
	# reads stdin and forwards non-empty lines to stderr.
 | 
					 | 
				
			||||||
	# returns 0 if stdin is empty, else 1.
 | 
					 | 
				
			||||||
	! grep -e . >&2
 | 
					 | 
				
			||||||
}
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
commit() {
 | 
					 | 
				
			||||||
	uci commit
 | 
					 | 
				
			||||||
}
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
rollback() {
 | 
					 | 
				
			||||||
	echo >&2
 | 
					 | 
				
			||||||
	echo 'An error occurred when trying to commit transaction ${transaction_name}!' >&2
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
	uci changes \\
 | 
					 | 
				
			||||||
	| sed -e 's/^-//' -e 's/\..*\$//' \\
 | 
					 | 
				
			||||||
	| sort -u \\
 | 
					 | 
				
			||||||
	| while read -r _package
 | 
					 | 
				
			||||||
	  do
 | 
					 | 
				
			||||||
		  uci revert "\${_package}"
 | 
					 | 
				
			||||||
		  echo "\${_package}"  # for logging
 | 
					 | 
				
			||||||
	  done \\
 | 
					 | 
				
			||||||
	| awk '
 | 
					 | 
				
			||||||
	  BEGIN { printf "Reverted changes in: " }
 | 
					 | 
				
			||||||
	  { printf "%s%s", (FNR > 1 ? ", " : ""), \$0 }
 | 
					 | 
				
			||||||
	  END { printf "\\n" }' >&2
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
	return 1
 | 
					 | 
				
			||||||
}
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
uci batch <<'EOF' 2>&1 | check_errors && commit || rollback
 | 
					 | 
				
			||||||
$(cat "${batchfile}")
 | 
					 | 
				
			||||||
EOF
 | 
					 | 
				
			||||||
CODE
 | 
					 | 
				
			||||||
| 
						 | 
					@ -1,60 +0,0 @@
 | 
				
			||||||
cdist-type__uci_commit(7)
 | 
					 | 
				
			||||||
=========================
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
NAME
 | 
					 | 
				
			||||||
----
 | 
					 | 
				
			||||||
cdist-type__uci_commit - Commit UCI transactions
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
DESCRIPTION
 | 
					 | 
				
			||||||
-----------
 | 
					 | 
				
			||||||
This type executes the ``uci commit`` command on the target with the commands
 | 
					 | 
				
			||||||
queued in a transaction.
 | 
					 | 
				
			||||||
It is usually not required to use this type. Use the ``--transaction`` parameter
 | 
					 | 
				
			||||||
of :strong:`cdist-type__uci`\ (7) and :strong:`cdist-type__uci_section`\ (7)
 | 
					 | 
				
			||||||
instead.
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
REQUIRED PARAMETERS
 | 
					 | 
				
			||||||
-------------------
 | 
					 | 
				
			||||||
None.
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
OPTIONAL PARAMETERS
 | 
					 | 
				
			||||||
-------------------
 | 
					 | 
				
			||||||
None.
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
BOOLEAN PARAMETERS
 | 
					 | 
				
			||||||
------------------
 | 
					 | 
				
			||||||
None.
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
EXAMPLES
 | 
					 | 
				
			||||||
--------
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
.. code-block:: sh
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
    # Commit the default transaction
 | 
					 | 
				
			||||||
    __uci_commit default
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
    # Commit another transaction
 | 
					 | 
				
			||||||
    __uci_commit my_transaction
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
SEE ALSO
 | 
					 | 
				
			||||||
--------
 | 
					 | 
				
			||||||
:strong:`cdist-type__uci`\ (7), :strong:`cdist-type__uci_section`\ (7)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
AUTHORS
 | 
					 | 
				
			||||||
-------
 | 
					 | 
				
			||||||
Dennis Camera <dennis.camera@ssrq-sds-fds.ch>
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
COPYING
 | 
					 | 
				
			||||||
-------
 | 
					 | 
				
			||||||
Copyright \(C) 2020 Dennis Camera. You can redistribute it
 | 
					 | 
				
			||||||
and/or modify it under the terms of the GNU General Public License as
 | 
					 | 
				
			||||||
published by the Free Software Foundation, either version 3 of the
 | 
					 | 
				
			||||||
License, or (at your option) any later version.
 | 
					 | 
				
			||||||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue