From 5b8ae33b4e0bad18f8b76b3cb326884dc16b9550 Mon Sep 17 00:00:00 2001
From: Dennis Camera <dennis.camera@ssrq-sds-fds.ch>
Date: Thu, 11 Jun 2020 15:21:35 +0200
Subject: [PATCH] [type/__dma_auth] Improve documentation and handle duplicate
 lines better

The state explorer gained a new value "multiple" (it is not used anywhere, just
informative).
The code will only write a "should" line once and drop duplicate lines.
---
 type/__dma_auth/explorer/state | 22 ++++++++++++++++------
 type/__dma_auth/gencode-remote | 10 +++++++---
 2 files changed, 23 insertions(+), 9 deletions(-)

diff --git a/type/__dma_auth/explorer/state b/type/__dma_auth/explorer/state
index 0e6f7be..668b50f 100755
--- a/type/__dma_auth/explorer/state
+++ b/type/__dma_auth/explorer/state
@@ -17,8 +17,13 @@
 # You should have received a copy of the GNU General Public License
 # along with cdist. If not, see <http://www.gnu.org/licenses/>.
 #
-# This explorer looks for lines matching the server parameter in dma's auth.conf
-# and reports the login and server fields (password is cksummed)
+# This explorer looks for a line matching the login and server parameters
+# in dma's auth.conf and reports:
+#   present:            a line matching login + host + password exists
+#   absent:             no line matching login + host exists
+#   different_password: a line exists but with a different pasword
+#   multiple:           multiple lines matching login + host exist
+#                       (should never happen)
 
 auth_conf=$("${__type_explorer}/auth_conf")
 test -r "${auth_conf}" || exit 0
@@ -32,6 +37,7 @@ fi
 
 awk -F'\n' -v server="${server}" '
 function getvalue(path) {
+	# Reads the first line of the file located at path and returns it.
 	getline < path
 	close(path)
 	return $0
@@ -42,6 +48,7 @@ BEGIN {
 
 	parameter_dir = ENVIRON["__object"] "/parameter/"
 
+	# Read the parameters of this object
 	host_param = getvalue(parameter_dir "server")
 	if (!host_param) host_param = ENVIRON["__object_id"]
 	login_param = getvalue(parameter_dir "login")
@@ -72,10 +79,13 @@ BEGIN {
 }
 
 host == host_param && login == login_param {
-	if (passwd == passwd_param)
-		state = "present"
-	else
-		state = "different_password"
+	# a match…
+	if (state == "absent") {
+		state = ((passwd == passwd_param) ? "present" : "different_password")
+	} else {
+		# report "multiple" to that the type can remove the duplicates.
+		state = "multiple"
+	}
 }
 
 END {
diff --git a/type/__dma_auth/gencode-remote b/type/__dma_auth/gencode-remote
index c49779f..46d9f31 100755
--- a/type/__dma_auth/gencode-remote
+++ b/type/__dma_auth/gencode-remote
@@ -78,6 +78,7 @@ test -f "${auth_conf}" || touch "${auth_conf}"
 
 awk -F '\n' -v mode=$mode '
 function getvalue(path) {
+	# Reads the first line of the file located at path and returns it.
 	getline < path
 	close(path)
 	return $0
@@ -124,11 +125,12 @@ host == host_param {
 	if (mode) {
 		# state_should == present
 		if (login == login_param && !written) {
-			# replace line if host and login match
+			# replace line if host and login match (but only if no line has
+			# been written already -> no duplicates)
 			print_should()
 			written = 1
-			next
 		}
+		next
 	} else {
 		# state_should == absent
 		if (!login_param || login == login_param) {
@@ -139,7 +141,9 @@ host == host_param {
 }
 
 # leave other lines alone
-{ print }
+{
+	print
+}
 
 END {
 	if (mode && !written) {