Merge ~dmzoneill/+git/vpn-host:dev/crontabs into ~dmzoneill/+git/vpn-host:master

[David O Neill]

Unmerged commits

d18de48... by David O Neill on 2021-02-08

Implement the feature to create crontab in /etc/cron.d/xxxx that runs iptables-dave > /x/y/z/$(date)
on given interval.

https://trello.com/b/Fq3KHMtu/bootstack-vpns-sprints-board

02ba69a... by David O Neill on 2020-08-24

Just some basic code for relation test

diff --git a/Makefile b/Makefile
index a3bbf95..6ee8f98 100644
--- a/Makefile
+++ b/Makefile
@@ -26,7 +26,11 @@ help:
 
 clean:
 	@echo "Cleaning files"
+<<<<<<< Makefile
 	@git clean -ffXd -e '!.idea'
+=======
+	@git clean -ffXd -e '!.idea' -e '!lib/vpncommon'
+>>>>>>> Makefile
 	@echo "Cleaning existing build"
 	@rm -rf ${CHARM_BUILD_DIR}/${CHARM_NAME}
 
@@ -43,6 +47,7 @@ build:
 	@-git rev-parse --abbrev-ref HEAD > ./repo-info
 	@-git describe --always > ./version
 	@mkdir -p ${CHARM_BUILD_DIR}/${CHARM_NAME}
+<<<<<<< Makefile
 	@cp -a ./* ${CHARM_BUILD_DIR}/${CHARM_NAME}
 	@echo "Installing/updating env if requirements.txt exists"
 	@mkdir -p ${CHARM_BUILD_DIR}/${CHARM_NAME}/env/
@@ -51,6 +56,19 @@ build:
 release: clean build
 	@echo "Charm is built at ${CHARM_BUILD_DIR}/${CHARM_NAME}"
 
+=======
+	@tox -e build
+	@mv ${CHARM_NAME}.charm ${CHARM_BUILD_DIR}/.
+
+release: clean build unpack
+	@echo "Charm is built at ${CHARM_BUILD_DIR}/${CHARM_NAME}"
+
+unpack: build
+	@mkdir -p ${CHARM_BUILD_DIR}/${CHARM_NAME}
+	@echo "Unpacking built .charm into ${CHARM_BUILD_DIR}/${CHARM_NAME}"
+	@cd ${CHARM_BUILD_DIR}/${CHARM_NAME} && unzip -q ${CHARM_BUILD_DIR}/${CHARM_NAME}.charm
+
+>>>>>>> Makefile
 lint:
 	@echo "Running lint checks"
 	@tox -e lint
@@ -59,6 +77,7 @@ black:
 	@echo "Reformat files with black"
 	@tox -e black
 
+<<<<<<< Makefile
 proof:
 	@echo "Running charm proof"
 	@-charm proof
@@ -66,6 +85,15 @@ proof:
 unittests:
 	@echo "Running unit tests"
 	@-tox -e unit
+=======
+proof: unpack
+	@echo "Running charm proof"
+	@cd ${CHARM_BUILD_DIR}/${CHARM_NAME} && charm proof
+
+unittests:
+	@echo "Running unit tests"
+	@tox -e unit
+>>>>>>> Makefile
 
 functional: build
 	@echo "Executing functional tests in ${CHARM_BUILD_DIR}"
@@ -75,4 +103,8 @@ test: lint proof unittests functional
 	@echo "Tests completed for charm ${CHARM_NAME}."
 
 # The targets below don't depend on a file
-.PHONY: help submodules submodules-update clean build release lint black proof unittests functional test
\ No newline at end of file
+<<<<<<< Makefile
+.PHONY: help submodules submodules-update clean build release lint black proof unittests functional test
+=======
+.PHONY: help submodules submodules-update clean build release lint black proof unittests functional test
+>>>>>>> Makefile
diff --git a/config.yaml b/config.yaml
index 25f8225..695b8d8 100644
--- a/config.yaml
+++ b/config.yaml
@@ -1,4 +1,5 @@
 options:
+<<<<<<< config.yaml
     example_string_config:
         type: string
         description: 'An example string configuration item'
@@ -11,3 +12,13 @@ options:
         type: boolean
         description: 'An example boolean configuration item'
         default: false
+=======
+    cron_iptables_save_interval:
+        type: string
+        description: '01 01 * * *\nhttps://help.ubuntu.com/community/CronHowto'
+        default: '01 01 * * *'
+    cron_iptables_save_retention:
+        type: int
+        description: 'Number of days to retain backups'
+        default: 21
+>>>>>>> config.yaml
diff --git a/requirements.txt b/requirements.txt
new file mode 100644
index 0000000..1655283
--- /dev/null
+++ b/requirements.txt
@@ -0,0 +1,5 @@
+charmhelpers
+jinja2
+ops
+distro
+numpy
\ No newline at end of file
diff --git a/src/charm.py b/src/charm.py
index 80c2c12..6dfa4a7 100755
--- a/src/charm.py
+++ b/src/charm.py
@@ -5,6 +5,7 @@
 
 """Operator Charm main library."""
 # Load modules from lib directory
+<<<<<<< src/charm.py
 import hashlib
 import json
 import logging
@@ -20,12 +21,29 @@ sys.path.append("lib")
 import iptc  # noqa:E402
 
 import setuppath  # noqa:F401
+=======
+import logging
+import netifaces
+import os
+
+>>>>>>> src/charm.py
 from ops.charm import CharmBase
 from ops.framework import StoredState
 from ops.main import main
 from ops.model import ActiveStatus, MaintenanceStatus
 from ops.framework import Object
 
+<<<<<<< src/charm.py
+=======
+from charmhelpers.fetch import apt_install
+from charmhelpers.fetch.python.packages import pip_install
+
+try:
+    import iptc  # noqa:E402
+except (ImportError, AttributeError):
+    apt_install(["python3-distutils"])
+    pip_install(["python-iptables"])
+>>>>>>> src/charm.py
 
 class VPNRequires(Object):
     def __init__(self, charm, relation_name):
@@ -101,8 +119,46 @@ class VpnHostCharm(CharmBase):
             logging.info("Stopping for configuration, event handle: {}".format(event.handle))
         # Configure the software
         logging.info("Configuring")
+<<<<<<< src/charm.py
+        self.state.configured = True
+
+=======
+        self.configure_crontabs()
         self.state.configured = True
 
+    def configure_crontabs(self):
+        save_folder = "/etc/vpnhost-backup/iptables"
+
+        if os.path.isdir(save_folder) is False:
+            logging.info(save_folder + " does not exist, attempting to create")
+            try:
+                os.makedirs(save_folder, exist_ok=True)
+            except OSError:
+                logging.info("Creation of the directory %s failed" % save_folder)
+            else:
+                logging.info("Successfully created the directory %s " % save_folder)
+
+        save_cronfile = open("/etc/cron.d/vpn-host-iptables-save", "w")
+        cron_iptables_save_interval = self.model.config["cron_iptables_save_interval"]
+        cronline = cron_iptables_save_interval
+        cronline += " root /sbin/iptables-save > "
+        cronline += save_folder
+        cronline += r"/`date +\%Y\%m\%d\%H\%M\%S`-cron.save"
+        save_cronfile.write(cronline)
+        save_cronfile.close()
+
+        cleanup_cronfile = open("/etc/cron.d/vpn-host-iptables-cleanup", "w")
+        cron_iptables_save_retention = self.model.config["cron_iptables_save_retention"]
+        cronline = "0 0 * * *"
+        cronline += " root /usr/bin/find "
+        cronline += save_folder
+        cronline += r" -type f -name \*.save -mtime +"
+        cronline += str(cron_iptables_save_retention)
+        cronline += r" -exec rm {} \;"
+        cleanup_cronfile.write(cronline)
+        cleanup_cronfile.close()
+
+>>>>>>> src/charm.py
     def _on_relation_changed(self, event):       
         ip = event.relation.data[event.unit].get('ip', None)
         ports = event.relation.data[event.unit].get('ports', None)
@@ -161,12 +217,28 @@ class VpnHostCharm(CharmBase):
             start_port += 1
         
         # find rules to delete
+<<<<<<< src/charm.py
         delete_these = np.setdiff1d(current_rules, new_rules)
+=======
+        delete_these = set(current_rules)
+        for item in new_rules:
+            if item in delete_these:
+                delete_these.remove(item)
+        # remaining is due for deletion
+>>>>>>> src/charm.py
         logging.info("delete these:")
         logging.info(delete_these)
 
         # find rules to add
+<<<<<<< src/charm.py
         add_these = np.setdiff1d(new_rules, current_rules)
+=======
+        add_these = set(new_rules)
+        for item in current_rules:
+            if item in add_these:
+                add_these.remove(item)
+        # remaning new_rules to be added
+>>>>>>> src/charm.py
         logging.info("add these:")
         logging.info(add_these)
 
diff --git a/tox.ini b/tox.ini
index 49c6e23..13a79b4 100644
--- a/tox.ini
+++ b/tox.ini
@@ -22,6 +22,13 @@ passenv =
   SNAP_HTTP_PROXY
   SNAP_HTTPS_PROXY
 
+<<<<<<< tox.ini
+=======
+[testenv:build]
+deps = charmcraft
+commands = charmcraft build
+
+>>>>>>> tox.ini
 [testenv:lint]
 commands =
     flake8
@@ -41,6 +48,10 @@ exclude =
     .tox,
     charmhelpers,
     mod,
+<<<<<<< tox.ini
+=======
+    build,
+>>>>>>> tox.ini
     .build
 
 max-line-length = 88
@@ -48,18 +59,41 @@ max-complexity = 10
 
 [testenv:black]
 commands =
+<<<<<<< tox.ini
     black --exclude "/(\.eggs|\.git|\.tox|\.venv|\.build|dist|charmhelpers|mod)/" .
+=======
+    black --exclude "/(\.eggs|\.git|\.tox|\.venv|\.build|dist|charmhelpers|mod|vpncommon)/" .
+>>>>>>> tox.ini
 deps =
     black
 
 [testenv:unit]
 commands =
     coverage run -m unittest discover -s {toxinidir}/tests/unit -v
+<<<<<<< tox.ini
     coverage report --omit tests/*,mod/*,.tox/*
     coverage html --omit tests/*,mod/*,.tox/*
 deps = -r{toxinidir}/tests/unit/requirements.txt
+=======
+    coverage report --omit tests/*,mod/*,.tox/*,lib/vpncommon/*
+    coverage html --omit tests/*,mod/*,.tox/*,lib/vpncommon/*
+deps = -r{toxinidir}/tests/unit/requirements.txt
+       -r{toxinidir}/requirements.txt
+>>>>>>> tox.ini
 
 [testenv:func]
 changedir = {toxinidir}/tests/functional
 commands = functest-run-suite {posargs}
-deps = -r{toxinidir}/tests/functional/requirements.txt
\ No newline at end of file
+<<<<<<< tox.ini
+deps = -r{toxinidir}/tests/functional/requirements.txt
+=======
+deps = -r{toxinidir}/tests/functional/requirements.txt
+
+[testenv:func-noop]
+basepython = python3
+commands =
+    functest-run-suite --help
+deps = -r{toxinidir}/tests/functional/requirements.txt
+       -r{toxinidir}/requirements.txt
+       -r{toxinidir}/tests/unit/requirements.txt
+>>>>>>> tox.ini