From 9d8f6704ff4964e23dc70e8d679cce64d218d648 Mon Sep 17 00:00:00 2001
From: Frank Wall <fw@moov.de>
Date: Tue, 17 Jan 2023 23:38:34 +0100
Subject: [PATCH 1/6] sysutils/puppet-agent: add default values for
 server+environment

---
 sysutils/puppet-agent/pkg-descr                             | 3 +++
 .../mvc/app/models/OPNsense/PuppetAgent/PuppetAgent.xml     | 6 +++---
 2 files changed, 6 insertions(+), 3 deletions(-)

diff --git a/sysutils/puppet-agent/pkg-descr b/sysutils/puppet-agent/pkg-descr
index 64ec7afe9..b525dbc6e 100644
--- a/sysutils/puppet-agent/pkg-descr
+++ b/sysutils/puppet-agent/pkg-descr
@@ -9,6 +9,9 @@ WWW:  https://puppet.com/docs/puppet/latest/man/agent.html
 Plugin Changelog
 ================
 
+Changed:
+* add default values for Puppet Server + Environment
+
 1.0
 
 Added:
diff --git a/sysutils/puppet-agent/src/opnsense/mvc/app/models/OPNsense/PuppetAgent/PuppetAgent.xml b/sysutils/puppet-agent/src/opnsense/mvc/app/models/OPNsense/PuppetAgent/PuppetAgent.xml
index f706d65a5..854add779 100644
--- a/sysutils/puppet-agent/src/opnsense/mvc/app/models/OPNsense/PuppetAgent/PuppetAgent.xml
+++ b/sysutils/puppet-agent/src/opnsense/mvc/app/models/OPNsense/PuppetAgent/PuppetAgent.xml
@@ -1,19 +1,19 @@
 <model>
     <mount>//OPNsense/puppetagent</mount>
-    <version>1.0.0</version>
+    <version>1.1.0</version>
     <description>Manage Puppet Agent service</description>
     <items>
-        <!-- container -->
         <general>
-            <!-- fields -->
             <Enabled type="BooleanField">
                 <default>0</default>
                 <Required>Y</Required>
             </Enabled>
             <FQDN type="HostnameField">
+                <default>puppet</default>
                 <Required>Y</Required>
             </FQDN>
             <Environment type="TextField">
+                <default>production</default>
                 <Required>Y</Required>
                 <mask>/^.{1,100}$/u</mask>
                 <ValidationMessage>Should be a string between 1 and 100 characters.</ValidationMessage>

From ed0e8f9487e7a3d07d2afa27a576c34c9621c6c6 Mon Sep 17 00:00:00 2001
From: Frank Wall <fw@moov.de>
Date: Wed, 18 Jan 2023 00:00:13 +0100
Subject: [PATCH 2/6] sysutils/puppet-agent: add runinterval and runtimeout

---
 sysutils/puppet-agent/pkg-descr                      |  3 +++
 .../OPNsense/PuppetAgent/forms/general.xml           | 12 ++++++++++++
 .../app/models/OPNsense/PuppetAgent/PuppetAgent.xml  | 12 ++++++++++++
 .../templates/OPNsense/PuppetAgent/puppetagent.conf  |  6 ++++++
 4 files changed, 33 insertions(+)

diff --git a/sysutils/puppet-agent/pkg-descr b/sysutils/puppet-agent/pkg-descr
index b525dbc6e..6ea5ec8e0 100644
--- a/sysutils/puppet-agent/pkg-descr
+++ b/sysutils/puppet-agent/pkg-descr
@@ -9,6 +9,9 @@ WWW:  https://puppet.com/docs/puppet/latest/man/agent.html
 Plugin Changelog
 ================
 
+Added:
+* add new options runinterval and runtimeout
+
 Changed:
 * add default values for Puppet Server + Environment
 
diff --git a/sysutils/puppet-agent/src/opnsense/mvc/app/controllers/OPNsense/PuppetAgent/forms/general.xml b/sysutils/puppet-agent/src/opnsense/mvc/app/controllers/OPNsense/PuppetAgent/forms/general.xml
index 6713c5ec4..6e5e408fe 100644
--- a/sysutils/puppet-agent/src/opnsense/mvc/app/controllers/OPNsense/PuppetAgent/forms/general.xml
+++ b/sysutils/puppet-agent/src/opnsense/mvc/app/controllers/OPNsense/PuppetAgent/forms/general.xml
@@ -17,4 +17,16 @@
         <type>text</type>
         <help>Change Puppet Agent Environment</help>
     </field>
+    <field>
+        <id>puppetagent.general.RunInterval</id>
+        <label>Run Interval</label>
+        <type>text</type>
+        <help>How often Puppet Agent applies the catalog. Enter a number followed by one of the supported suffixes: "y" (years), "d" (days), "h" (hours), "m" (minutes), "s" (seconds).</help>
+    </field>
+    <field>
+        <id>puppetagent.general.RunTimeout</id>
+        <label>Run Timeout</label>
+        <type>text</type>
+        <help>The maximum amount of time an agent run is allowed to take. Enter a number followed by one of the supported suffixes: "y" (years), "d" (days), "h" (hours), "m" (minutes), "s" (seconds).</help>
+    </field>
 </form>
diff --git a/sysutils/puppet-agent/src/opnsense/mvc/app/models/OPNsense/PuppetAgent/PuppetAgent.xml b/sysutils/puppet-agent/src/opnsense/mvc/app/models/OPNsense/PuppetAgent/PuppetAgent.xml
index 854add779..637901373 100644
--- a/sysutils/puppet-agent/src/opnsense/mvc/app/models/OPNsense/PuppetAgent/PuppetAgent.xml
+++ b/sysutils/puppet-agent/src/opnsense/mvc/app/models/OPNsense/PuppetAgent/PuppetAgent.xml
@@ -18,6 +18,18 @@
                 <mask>/^.{1,100}$/u</mask>
                 <ValidationMessage>Should be a string between 1 and 100 characters.</ValidationMessage>
             </Environment>
+            <RunInterval type="TextField">
+                <default>30m</default>
+                <mask>/^([0-9]{1,8}(?:s|m|h|d|y)?)/u</mask>
+                <ValidationMessage>Should be a number between 1 and 8 characters, optionally followed by either "y", "d", "h", "m" or "s".</ValidationMessage>
+                <Required>Y</Required>
+            </RunInterval>
+            <RunTimeout type="TextField">
+                <default>1h</default>
+                <mask>/^([0-9]{1,8}(?:s|m|h|d|y)?)/u</mask>
+                <ValidationMessage>Should be a number between 1 and 8 characters, optionally followed by either "y", "d", "h", "m" or "s".</ValidationMessage>
+                <Required>Y</Required>
+            </RunTimeout>
         </general>
     </items>
 </model>
diff --git a/sysutils/puppet-agent/src/opnsense/service/templates/OPNsense/PuppetAgent/puppetagent.conf b/sysutils/puppet-agent/src/opnsense/service/templates/OPNsense/PuppetAgent/puppetagent.conf
index c375941a9..86fb47632 100644
--- a/sysutils/puppet-agent/src/opnsense/service/templates/OPNsense/PuppetAgent/puppetagent.conf
+++ b/sysutils/puppet-agent/src/opnsense/service/templates/OPNsense/PuppetAgent/puppetagent.conf
@@ -3,6 +3,12 @@
 certname = {{ system.hostname|lower }}.{{ system.domain|lower }}
 server = {{ OPNsense.puppetagent.general.FQDN|default("") }}
 logdest = /var/log/puppet-agent.log
+{% if OPNsense.puppetagent.general.RunInterval|default("") != "" %}
+runinterval = {{ OPNsense.puppetagent.general.RunInterval }}
+{% endif %}
+{% if OPNsense.puppetagent.general.RunTimeout|default("") != "" %}
+runtimeout = {{ OPNsense.puppetagent.general.RunTimeout}}
+{% endif %}
 {% if helpers.exists('OPNsense.puppetagent.general') and not helpers.empty('OPNsense.puppetagent.general.Environment') %}
 [agent]
 environment = {{ OPNsense.puppetagent.general.Environment|default("") }}

From 07c9c9fe870db9939c629550f5bedd7b8ed8a960 Mon Sep 17 00:00:00 2001
From: Frank Wall <fw@moov.de>
Date: Wed, 18 Jan 2023 00:13:39 +0100
Subject: [PATCH 3/6] sysutils/puppet-agent: add usecacheonfailure

---
 sysutils/puppet-agent/pkg-descr                             | 1 +
 .../app/controllers/OPNsense/PuppetAgent/forms/general.xml  | 6 ++++++
 .../mvc/app/models/OPNsense/PuppetAgent/PuppetAgent.xml     | 4 ++++
 .../service/templates/OPNsense/PuppetAgent/puppetagent.conf | 5 +++++
 4 files changed, 16 insertions(+)

diff --git a/sysutils/puppet-agent/pkg-descr b/sysutils/puppet-agent/pkg-descr
index 6ea5ec8e0..2fbad135e 100644
--- a/sysutils/puppet-agent/pkg-descr
+++ b/sysutils/puppet-agent/pkg-descr
@@ -11,6 +11,7 @@ Plugin Changelog
 
 Added:
 * add new options runinterval and runtimeout
+* add new option usecacheonfailure
 
 Changed:
 * add default values for Puppet Server + Environment
diff --git a/sysutils/puppet-agent/src/opnsense/mvc/app/controllers/OPNsense/PuppetAgent/forms/general.xml b/sysutils/puppet-agent/src/opnsense/mvc/app/controllers/OPNsense/PuppetAgent/forms/general.xml
index 6e5e408fe..adc9330b5 100644
--- a/sysutils/puppet-agent/src/opnsense/mvc/app/controllers/OPNsense/PuppetAgent/forms/general.xml
+++ b/sysutils/puppet-agent/src/opnsense/mvc/app/controllers/OPNsense/PuppetAgent/forms/general.xml
@@ -29,4 +29,10 @@
         <type>text</type>
         <help>The maximum amount of time an agent run is allowed to take. Enter a number followed by one of the supported suffixes: "y" (years), "d" (days), "h" (hours), "m" (minutes), "s" (seconds).</help>
     </field>
+    <field>
+        <id>puppetagent.general.UseCacheOnFailure</id>
+        <label>Use Cache On Failure</label>
+        <type>checkbox</type>
+        <help>Whether to use the cached configuration when the remote configuration will not compile.</help>
+    </field>
 </form>
diff --git a/sysutils/puppet-agent/src/opnsense/mvc/app/models/OPNsense/PuppetAgent/PuppetAgent.xml b/sysutils/puppet-agent/src/opnsense/mvc/app/models/OPNsense/PuppetAgent/PuppetAgent.xml
index 637901373..ffba1a25d 100644
--- a/sysutils/puppet-agent/src/opnsense/mvc/app/models/OPNsense/PuppetAgent/PuppetAgent.xml
+++ b/sysutils/puppet-agent/src/opnsense/mvc/app/models/OPNsense/PuppetAgent/PuppetAgent.xml
@@ -30,6 +30,10 @@
                 <ValidationMessage>Should be a number between 1 and 8 characters, optionally followed by either "y", "d", "h", "m" or "s".</ValidationMessage>
                 <Required>Y</Required>
             </RunTimeout>
+            <UseCacheOnFailure type="BooleanField">
+                <default>1</default>
+                <Required>Y</Required>
+            </UseCacheOnFailure>
         </general>
     </items>
 </model>
diff --git a/sysutils/puppet-agent/src/opnsense/service/templates/OPNsense/PuppetAgent/puppetagent.conf b/sysutils/puppet-agent/src/opnsense/service/templates/OPNsense/PuppetAgent/puppetagent.conf
index 86fb47632..51e6fa915 100644
--- a/sysutils/puppet-agent/src/opnsense/service/templates/OPNsense/PuppetAgent/puppetagent.conf
+++ b/sysutils/puppet-agent/src/opnsense/service/templates/OPNsense/PuppetAgent/puppetagent.conf
@@ -9,6 +9,11 @@ runinterval = {{ OPNsense.puppetagent.general.RunInterval }}
 {% if OPNsense.puppetagent.general.RunTimeout|default("") != "" %}
 runtimeout = {{ OPNsense.puppetagent.general.RunTimeout}}
 {% endif %}
+{% if OPNsense.puppetagent.general.UseCacheOnFailure|default("0") == "1" %}
+usecacheonfailure = true
+{% else %}
+usecacheonfailure = false
+{% endif %}
 {% if helpers.exists('OPNsense.puppetagent.general') and not helpers.empty('OPNsense.puppetagent.general.Environment') %}
 [agent]
 environment = {{ OPNsense.puppetagent.general.Environment|default("") }}

From 5f58842f5667f7dc8bb0c8a501a2cd2a2565f59a Mon Sep 17 00:00:00 2001
From: Frank Wall <fw@moov.de>
Date: Wed, 18 Jan 2023 00:20:27 +0100
Subject: [PATCH 4/6] sysutils/puppet-agent: don't wipe puppet.conf

While here, improve readability of the template and the resulting puppet.conf.
---
 sysutils/puppet-agent/pkg-descr               |  1 +
 .../OPNsense/PuppetAgent/puppetagent.conf     | 21 +++++++++----------
 2 files changed, 11 insertions(+), 11 deletions(-)

diff --git a/sysutils/puppet-agent/pkg-descr b/sysutils/puppet-agent/pkg-descr
index 2fbad135e..1581f039f 100644
--- a/sysutils/puppet-agent/pkg-descr
+++ b/sysutils/puppet-agent/pkg-descr
@@ -15,6 +15,7 @@ Added:
 
 Changed:
 * add default values for Puppet Server + Environment
+* don't wipe puppet.conf if service is disabled
 
 1.0
 
diff --git a/sysutils/puppet-agent/src/opnsense/service/templates/OPNsense/PuppetAgent/puppetagent.conf b/sysutils/puppet-agent/src/opnsense/service/templates/OPNsense/PuppetAgent/puppetagent.conf
index 51e6fa915..dc3a3649d 100644
--- a/sysutils/puppet-agent/src/opnsense/service/templates/OPNsense/PuppetAgent/puppetagent.conf
+++ b/sysutils/puppet-agent/src/opnsense/service/templates/OPNsense/PuppetAgent/puppetagent.conf
@@ -1,21 +1,20 @@
-{% if helpers.exists('OPNsense.puppetagent.general') and OPNsense.puppetagent.general.Enabled|default("0") == "1" %}
 [main]
-certname = {{ system.hostname|lower }}.{{ system.domain|lower }}
-server = {{ OPNsense.puppetagent.general.FQDN|default("") }}
-logdest = /var/log/puppet-agent.log
+  certname = {{ system.hostname|lower }}.{{ system.domain|lower }}
+  logdest = /var/log/puppet-agent.log
 {% if OPNsense.puppetagent.general.RunInterval|default("") != "" %}
-runinterval = {{ OPNsense.puppetagent.general.RunInterval }}
+  runinterval = {{ OPNsense.puppetagent.general.RunInterval }}
 {% endif %}
 {% if OPNsense.puppetagent.general.RunTimeout|default("") != "" %}
-runtimeout = {{ OPNsense.puppetagent.general.RunTimeout}}
+  runtimeout = {{ OPNsense.puppetagent.general.RunTimeout}}
 {% endif %}
+  server = {{ OPNsense.puppetagent.general.FQDN|default("") }}
 {% if OPNsense.puppetagent.general.UseCacheOnFailure|default("0") == "1" %}
-usecacheonfailure = true
+  usecacheonfailure = true
 {% else %}
-usecacheonfailure = false
+  usecacheonfailure = false
 {% endif %}
-{% if helpers.exists('OPNsense.puppetagent.general') and not helpers.empty('OPNsense.puppetagent.general.Environment') %}
+
 [agent]
-environment = {{ OPNsense.puppetagent.general.Environment|default("") }}
-{% endif %}
+{% if not helpers.empty('OPNsense.puppetagent.general.Environment') %}
+  environment = {{ OPNsense.puppetagent.general.Environment|default("") }}
 {% endif %}

From 2ed53b33386f001e2cef536b62d24f46f96767d1 Mon Sep 17 00:00:00 2001
From: Frank Wall <fw@moov.de>
Date: Wed, 18 Jan 2023 00:21:27 +0100
Subject: [PATCH 5/6] sysutils/puppet-agent: bump version to 1.1

---
 sysutils/puppet-agent/Makefile  | 3 +--
 sysutils/puppet-agent/pkg-descr | 2 ++
 2 files changed, 3 insertions(+), 2 deletions(-)

diff --git a/sysutils/puppet-agent/Makefile b/sysutils/puppet-agent/Makefile
index 49d767c9d..a7112f55c 100644
--- a/sysutils/puppet-agent/Makefile
+++ b/sysutils/puppet-agent/Makefile
@@ -1,6 +1,5 @@
 PLUGIN_NAME=		puppet-agent
-PLUGIN_VERSION=		1.0
-PLUGIN_REVISION=	1
+PLUGIN_VERSION=		1.1
 PLUGIN_COMMENT=		Manage Puppet Agent
 PLUGIN_DEPENDS=		puppet7 py${PLUGIN_PYTHON}-opn-cli
 PLUGIN_MAINTAINER=	jan.wink93@gmail.com
diff --git a/sysutils/puppet-agent/pkg-descr b/sysutils/puppet-agent/pkg-descr
index 1581f039f..3e8426bcb 100644
--- a/sysutils/puppet-agent/pkg-descr
+++ b/sysutils/puppet-agent/pkg-descr
@@ -9,6 +9,8 @@ WWW:  https://puppet.com/docs/puppet/latest/man/agent.html
 Plugin Changelog
 ================
 
+1.1
+
 Added:
 * add new options runinterval and runtimeout
 * add new option usecacheonfailure

From 2f04229bc5439efd7f8af9ffbeda19a8d16ce031 Mon Sep 17 00:00:00 2001
From: Frank Wall <fw@moov.de>
Date: Wed, 18 Jan 2023 00:26:32 +0100
Subject: [PATCH 6/6] sysutils/puppet-agent: improve help text

---
 .../app/controllers/OPNsense/PuppetAgent/forms/general.xml  | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/sysutils/puppet-agent/src/opnsense/mvc/app/controllers/OPNsense/PuppetAgent/forms/general.xml b/sysutils/puppet-agent/src/opnsense/mvc/app/controllers/OPNsense/PuppetAgent/forms/general.xml
index adc9330b5..ce6b4412b 100644
--- a/sysutils/puppet-agent/src/opnsense/mvc/app/controllers/OPNsense/PuppetAgent/forms/general.xml
+++ b/sysutils/puppet-agent/src/opnsense/mvc/app/controllers/OPNsense/PuppetAgent/forms/general.xml
@@ -3,19 +3,19 @@
         <id>puppetagent.general.Enabled</id>
         <label>Enabled</label>
         <type>checkbox</type>
-        <help>Enable Puppet Agent</help>
+        <help>Enable the Puppet Agent service.</help>
     </field>
     <field>
         <id>puppetagent.general.FQDN</id>
         <label>Puppet Server FQDN</label>
         <type>text</type>
-        <help>Change Puppet Server FQDN</help>
+        <help>The primary Puppet Server to which the Puppet Agent should connect.</help>
     </field>
     <field>
         <id>puppetagent.general.Environment</id>
         <label>Puppet Environment</label>
         <type>text</type>
-        <help>Change Puppet Agent Environment</help>
+        <help>The environment in which Puppet is running.</help>
     </field>
     <field>
         <id>puppetagent.general.RunInterval</id>