Fix __package* state usage

Removed __package*/parameter/required
Added state to __package*/parameter/optional
Modified man pages for __package*
Added optional check for state parameter
Defaulted state parameter to "present"
remotes/origin/2.0
Jake Guffey 13 years ago
parent 17858ebd00
commit 1fef54ecdf
  1. 8
      conf/type/__package/man.text
  2. 1
      conf/type/__package/parameter/optional
  3. 1
      conf/type/__package/parameter/required
  4. 6
      conf/type/__package_apt/gencode-remote
  5. 8
      conf/type/__package_apt/man.text
  6. 1
      conf/type/__package_apt/parameter/optional
  7. 1
      conf/type/__package_apt/parameter/required
  8. 6
      conf/type/__package_luarocks/gencode-remote
  9. 8
      conf/type/__package_luarocks/man.text
  10. 1
      conf/type/__package_luarocks/parameter/optional
  11. 1
      conf/type/__package_luarocks/parameter/required
  12. 7
      conf/type/__package_opkg/gencode-remote
  13. 6
      conf/type/__package_opkg/man.text
  14. 1
      conf/type/__package_opkg/parameter/optional
  15. 1
      conf/type/__package_opkg/parameter/required
  16. 6
      conf/type/__package_pacman/gencode-remote
  17. 8
      conf/type/__package_pacman/man.text
  18. 1
      conf/type/__package_pacman/parameter/optional
  19. 1
      conf/type/__package_pacman/parameter/required
  20. 6
      conf/type/__package_pip/gencode-remote
  21. 6
      conf/type/__package_pip/man.text
  22. 1
      conf/type/__package_pip/parameter/optional
  23. 1
      conf/type/__package_pip/parameter/required
  24. 6
      conf/type/__package_pkg_freebsd/gencode-remote
  25. 6
      conf/type/__package_pkg_freebsd/man.text
  26. 1
      conf/type/__package_pkg_freebsd/parameter/optional
  27. 1
      conf/type/__package_pkg_freebsd/parameter/required
  28. 6
      conf/type/__package_pkg_openbsd/gencode-remote
  29. 8
      conf/type/__package_pkg_openbsd/man.text
  30. 1
      conf/type/__package_pkg_openbsd/parameter/optional
  31. 1
      conf/type/__package_pkg_openbsd/parameter/required
  32. 6
      conf/type/__package_rubygem/gencode-remote
  33. 8
      conf/type/__package_rubygem/man.text
  34. 1
      conf/type/__package_rubygem/parameter/optional
  35. 1
      conf/type/__package_rubygem/parameter/required
  36. 6
      conf/type/__package_yum/gencode-remote
  37. 8
      conf/type/__package_yum/man.text
  38. 1
      conf/type/__package_yum/parameter/optional
  39. 1
      conf/type/__package_yum/parameter/required
  40. 6
      conf/type/__package_zypper/gencode-remote
  41. 6
      conf/type/__package_zypper/man.text
  42. 1
      conf/type/__package_zypper/parameter/optional
  43. 1
      conf/type/__package_zypper/parameter/required

@ -16,9 +16,7 @@ It dispatches the actual work to the package system dependant types.
REQUIRED PARAMETERS
-------------------
state::
The state the package should be in, either "present" or "absent"
(the old values "installed" or "removed" will be removed in cdist 2.1).
None
OPTIONAL PARAMETERS
@ -35,6 +33,10 @@ type::
e.g. __package_apt for Debian
__package_emerge for Gentoo
state::
The state the package should be in, either "present" or "absent"
(the old values "installed" or "removed" will be removed in cdist 2.1).
EXAMPLES
--------

@ -2,3 +2,4 @@ name
version
type
pkgsite
state

@ -27,7 +27,11 @@ else
name="$__object_id"
fi
state_should="$(cat "$__object/parameter/state")"
if [ -f "$__object/parameter/state" ]; then
state_should="$(cat "$__object/parameter/state")"
else
state_should="present"
fi
# Correct pre 2.1 naming - FIXME in 2.1
case "$state_should" in

@ -16,9 +16,7 @@ manage packages.
REQUIRED PARAMETERS
-------------------
state::
The state the package should be in, either "present" or "absent"
(the old values "installed" or "removed" will be removed in cdist 2.1).
None
OPTIONAL PARAMETERS
@ -26,6 +24,10 @@ OPTIONAL PARAMETERS
name::
If supplied, use the name and not the object id as the package name.
state::
The state the package should be in, either "present" or "absent"
(the old values "installed" or "removed" will be removed in cdist 2.1).
EXAMPLES
--------

@ -29,7 +29,11 @@ else
name="$__object_id"
fi
state_should="$(cat "$__object/parameter/state")"
if [ -f "$__object/parameter/state" ]; then
state_should="$(cat "$__object/parameter/state")"
else
state_should="present"
fi
# Correct pre 2.1 naming - FIXME in 2.1
case "$state_should" in
installed)

@ -15,9 +15,7 @@ LuaRocks is a deployment and management system for Lua modules.
REQUIRED PARAMETERS
-------------------
state::
The state the package should be in, either "present" or "absent"
(the old values "installed" or "removed" will be removed in cdist 2.1).
None
OPTIONAL PARAMETERS
@ -25,6 +23,10 @@ OPTIONAL PARAMETERS
name::
If supplied, use the name and not the object id as the package name.
state::
The state the package should be in, either "present" or "absent"
(the old values "installed" or "removed" will be removed in cdist 2.1).
EXAMPLES
--------

@ -28,7 +28,12 @@ else
name="$__object_id"
fi
state_should="$(cat "$__object/parameter/state")"
if [ -f "$__object/parameter/state" ]; then
state_should="$(cat "$__object/parameter/state")"
else
state_should="present"
fi
state_is="$(cat "$__object/explorer/pkg_status")"
case "$state_is" in
absent*)

@ -15,8 +15,7 @@ opkg is usually used on OpenWRT to manage packages.
REQUIRED PARAMETERS
-------------------
state::
The state the package should be in, either "present" or "absent"
None
OPTIONAL PARAMETERS
@ -24,6 +23,9 @@ OPTIONAL PARAMETERS
name::
If supplied, use the name and not the object id as the package name.
state::
The state the package should be in, either "present" or "absent"
EXAMPLES
--------

@ -31,7 +31,11 @@ else
name="$__object_id"
fi
state_should="$(cat "$__object/parameter/state")"
if [ -f "$__object/parameter/state" ]; then
state_should="$(cat "$__object/parameter/state")"
else
state_should="present"
fi
case "$state_should" in
installed)
echo "WARNING: ${__object_name}: $state_should is deprecated and will be removed in cdist 2.1. Please change to present/absent." >&2

@ -16,9 +16,7 @@ packages.
REQUIRED PARAMETERS
-------------------
state::
The state the package should be in, either "present" or "absent"
(the old values "installed" or "removed" will be removed in cdist 2.1).
None
OPTIONAL PARAMETERS
@ -26,6 +24,10 @@ OPTIONAL PARAMETERS
name::
If supplied, use the name and not the object id as the package name.
state::
The state the package should be in, either "present" or "absent"
(the old values "installed" or "removed" will be removed in cdist 2.1).
EXAMPLES
--------

@ -22,7 +22,11 @@
#
state_is=$(cat "$__object/explorer/state")
state_should=$(cat "$__object/parameter/state")
if [ -f "$__object/parameter/state" ]; then
state_should="$(cat "$__object/parameter/state")"
else
state_should="present"
fi
[ "$state_is" = "$state_should" ] && exit 0

@ -16,8 +16,7 @@ It is also included in the python virtualenv environment.
REQUIRED PARAMETERS
-------------------
state::
Either "present" or "absent".
None
OPTIONAL PARAMETERS
@ -28,6 +27,9 @@ name::
pip::
Instead of using pip from PATH, use the specific pip path.
state::
Either "present" or "absent".
EXAMPLES
--------

@ -63,7 +63,11 @@ if [ -f "$__object/parameter/pkgsite" ]; then
pkgsite="$(cat "$__object/parameter/pkgsite")"
fi
state="$(cat "$__object/parameter/state")"
if [ -f "$__object/parameter/state" ]; then
state="$(cat "$__object/parameter/state")"
else
state="present"
fi
curr_version="$(cat "$__object/explorer/pkg_version")"
add_cmd="pkg_add"
rm_cmd="pkg_delete"

@ -15,8 +15,7 @@ This type is usually used on FreeBSD to manage packages.
REQUIRED PARAMETERS
-------------------
state::
Either "present" or "absent".
None
OPTIONAL PARAMETERS
@ -33,6 +32,9 @@ version::
pkgsite::
If supplied, use to install from a specific package repository.
state::
Either "present" or "absent".
EXAMPLES
--------

@ -2,3 +2,4 @@ name
flavor
version
pkgsite
state

@ -42,7 +42,11 @@ else
name="$__object_id"
fi
state_should="$(cat "$__object/parameter/state")"
if [ -f "$__object/parameter/state" ]; then
state_should="$(cat "$__object/parameter/state")"
else
state_should="present"
fi
# Correct pre 2.1 naming - FIXME in 2.1
case "$state_should" in
installed)

@ -15,9 +15,7 @@ This type is usually used on OpenBSD to manage packages.
REQUIRED PARAMETERS
-------------------
state::
The state the package should be in, either "present" or "absent"
(the old values "installed" or "removed" will be removed in cdist 2.1).
None
OPTIONAL PARAMETERS
@ -28,6 +26,10 @@ name::
flavor::
If supplied, use to avoid ambiguity.
state::
The state the package should be in, either "present" or "absent"
(the old values "installed" or "removed" will be removed in cdist 2.1).
EXAMPLES
--------

@ -27,7 +27,11 @@ else
name="$__object_id"
fi
state_should="$(cat "$__object/parameter/state")"
if [ -f "$__object/parameter/state" ]; then
state_should="$(cat "$__object/parameter/state")"
else
state_should="present"
fi
# Correct pre 2.1 naming - FIXME in 2.1
case "$state_should" in
installed)

@ -15,9 +15,7 @@ Rubygems is the default package management system for the Ruby programming langu
REQUIRED PARAMETERS
-------------------
state::
The state the package should be in, either "present" or "absent"
(the old values "installed" or "removed" will be removed in cdist 2.1).
None
OPTIONAL PARAMETERS
@ -25,6 +23,10 @@ OPTIONAL PARAMETERS
name::
If supplied, use the name and not the object id as the package name.
state::
The state the package should be in, either "present" or "absent"
(the old values "installed" or "removed" will be removed in cdist 2.1).
EXAMPLES
--------

@ -27,7 +27,11 @@ else
name="$__object_id"
fi
state_should="$(cat "$__object/parameter/state")"
if [ -f "$__object/parameter/state" ]; then
state_should="$(cat "$__object/parameter/state")"
else
state_should="present"
fi
case "$state_should" in
installed)
echo "WARNING: ${__object_name}: $state_should is deprecated and will be removed in cdist 2.1. Please change to present/absent." >&2

@ -17,9 +17,7 @@ slightly confusing error message "Error: Nothing to do".
REQUIRED PARAMETERS
-------------------
state::
The state the package should be in, either "present" or "absent"
(the old values "installed" or "removed" will be removed in cdist 2.1).
None
OPTIONAL PARAMETERS
@ -27,6 +25,10 @@ OPTIONAL PARAMETERS
name::
If supplied, use the name and not the object id as the package name.
state::
The state the package should be in, either "present" or "absent"
(the old values "installed" or "removed" will be removed in cdist 2.1).
EXAMPLES
--------

@ -33,7 +33,11 @@ else
name="$__object_id"
fi
state_should="$(cat "$__object/parameter/state")"
if [ -f "$__object/parameter/state" ]; then
state_should="$(cat "$__object/parameter/state")"
else
state_should="present"
fi
# Exit if nothing is needed to be done
[ "$state_is" = "$state_should" ] && exit 0

@ -15,8 +15,7 @@ Zypper is usually used on the SuSE distribution to manage packages.
REQUIRED PARAMETERS
-------------------
state::
The state the package should be in, either "present" or "absent"
None
OPTIONAL PARAMETERS
@ -24,6 +23,9 @@ OPTIONAL PARAMETERS
name::
If supplied, use the name and not the object id as the package name.
state::
The state the package should be in, either "present" or "absent"
EXAMPLES
--------

Loading…
Cancel
Save