Add Matomo software release

See merge request nexedi/slapos!1130

software/matomo/apache-httpd.conf.in

+<VirtualHost *:{{ parameter_dict['port'] }}>
+  ServerAdmin admin@example.com
+  DocumentRoot {{ parameter_dict['document-root'] }}/matomo
+
+  SetEnvIf Origin "^http(s)?://(.+\.)?(app\.officejs\.com)$" ORIGIN_DOMAIN=$0
+  Header always set Access-Control-Allow-Origin "%{ORIGIN_DOMAIN}e" env=ORIGIN_DOMAIN
+  Header always set Access-Control-Allow-Credentials "true" env=ORIGIN_DOMAIN
+  Header always set Access-Control-Allow-Methods "PROPFIND, PROPPATCH, COPY, MOVE, DELETE, MKCOL, LOCK, UNLOCK, PUT, GETLIB, VERSION-CONTROL, CHECKIN, CHECKOUT, UNCHECKOUT, REPORT, UPDATE, CANCELUPLOAD, HEAD, OPTIONS, GET, POST" env=ORIGIN_DOMAIN
+  Header always set Access-Control-Allow-Headers "Overwrite, Destination, Content-Type, Depth, User-Agent, X-File-Size, X-Requested-With, If-Modified-Since, X-File-Name, Cache-Control, Authorization" env=ORIGIN_DOMAIN
+  Header always set Strict-Transport-Security "max-age=15552000; includeSubDomains"
+
+  <Directory {{ parameter_dict['document-root'] }}>
+      Options +FollowSymlinks
+      AllowOverride All
+      Require all granted
+      SetEnv HOME {{ parameter_dict['document-root'] }}
+      SetEnv HTTP_HOME {{ parameter_dict['document-root'] }}
+      Dav off
+
+  </Directory>
+  ErrorLog "{{ parameter_dict['log-dir'] }}/matomo-error.log"
+  CustomLog "{{ parameter_dict['log-dir'] }}/matomo-access.log" combined
+
+</VirtualHost>

software/matomo/buildout.hash.cfg

+# THIS IS NOT A BUILDOUT FILE, despite purposedly using a compatible syntax.
+# The only allowed lines here are (regexes):
+# - "^#" comments, copied verbatim
+# - "^[" section beginings, copied verbatim
+# - lines containing an "=" sign which must fit in the following categorie.
+#   - "^\s*filename\s*=\s*path\s*$" where "path" is relative to this file
+#     Copied verbatim.
+#   - "^\s*hashtype\s*=.*" where "hashtype" is one of the values supported
+#     by the re-generation script.
+#     Re-generated.
+# - other lines are copied verbatim
+# Substitution (${...:...}), extension ([buildout] extends = ...) and
+# section inheritance (< = ...) are NOT supported (but you should really
+# not need these here).
+
+[template-apache-httpd]
+filename = apache-httpd.conf.in
+md5sum = 9940e05d5e624a7884f4e6e062355798
+
+[template-matomo-instance]
+filename = matomo-instance.cfg.in
+md5sum = cd5d8b83fef478b2fbb4ccc9489f47ed
+
+[template-matomo-backup.sh]
+filename = matomo-backup.sh.in
+md5sum = d11e34a576e580d4253fbe787f85e5cc

software/matomo/matomo-backup.sh.in

+#!/bin/bash
+
+set -e
+set -x
+
+#checkout if directory and matomo resources exist
+
+if [ ! -d {{ parameter_dict['document-root'] }}/matomo/config ]; then
+  exit 1;
+fi
+
+if [ ! -f {{ parameter_dict['document-root'] }}/matomo/config/config.ini.php ]; then
+  exit 0;
+fi
+
+#create plugins backup file
+touch {{ parameter_dict['dir-backup'] }}/plugins_list
+
+#remove backup file before
+if [ -d {{ parameter_dict['dir-backup'] }}/config ]; then     
+  rm -rf {{ parameter_dict['dir-backup'] }}/config   
+fi  
+
+if [ -d {{ parameter_dict['dir-backup'] }}/plugins ]; then     
+  rm -rf {{ parameter_dict['dir-backup'] }}/plugins   
+fi    
+
+#backup
+{{ php_bin }} {{ parameter_dict['document-root'] }}/matomo/console plugin:list > {{ parameter_dict['dir-backup'] }}/plugins_list
+cp -rf {{ parameter_dict['document-root'] }}/matomo/config {{ parameter_dict['dir-backup'] }}
+cp -rf {{ parameter_dict['document-root'] }}/matomo/plugins {{ parameter_dict['dir-backup'] }}
+exit 0

software/matomo/matomo-instance.cfg.in

+# parameters required by the configuration instance
+[instance-parameter]
+matomo = ${:document-root}
+dir-backup = ${directory:backup}
+
+#php.ini parameters
+php.memory_limit = 512M
+php.date.timezone = Europe/Paris
+php.upload_max_filesize = 10240M
+php.post_max_size = 10240M
+php.session.cookie_secure = True
+php.max_execution_time = 1800
+php.max_input_time = 3600
+php.output_buffering = 'Off'
+php.max_file_uploads = 100
+
+[php-bin]
+recipe = slapos.cookbook:wrapper
+wrapper-path = ${directory:bin}/php
+command-line = ${instance-parameter:php-bin} -c ${php.ini-conf:rendered} 
+
+[matomo-backup-cron]
+recipe = slapos.cookbook:cron.d
+cron-entries = ${cron:cron-entries}
+name = matomo-backup
+frequency = 0 0 * * *
+command = ${matomo-backup.sh:rendered}
+
+[matomo-apache-httpd]
+recipe = slapos.recipe.template:jinja2
+template = {{ matomo_apache_httpd }}
+rendered = ${directory:apache.d}/matomo.conf
+context =
+  section parameter_dict apache-php-configuration
+
+[matomo-backup.sh]
+recipe = slapos.recipe.template:jinja2
+template = {{ matomo_backup_sh }}
+rendered = ${directory:scripts}/matomo-backup
+context =
+  section parameter_dict instance-parameter
+  key php_bin php-bin:wrapper-path
+depends =
+  ${matomo-apache-httpd:recipe}
+  ${matomo-backup-cron:recipe}
+
+[slap-parameter]
+instance.cli-url = ${apache-php-configuration:url}
+
+
+

software/matomo/software.cfg

+[buildout]
+extends =
+  buildout.hash.cfg
+#apache-php mariadb zilb ...
+  ../../stack/lamp/buildout.cfg
+# "slapos" stack describes basic things needed for 99.9% of SlapOS Software
+  ../../stack/slapos.cfg
+  
+parts =
+# Call installation of slapos.cookbook egg defined in stack/slapos.cfg (needed
+# in 99,9% of Slapos Software Releases)
+  slapos-cookbook
+# to create file instance-matomo.cfg in instance of apache-php
+  template-matomo-instance
+# to create file instance.cfg of all instances
+  instance
+
+# download bas
+# inherited by modules that need to download files
+[matomo-download]
+recipe = slapos.recipe.build:download
+url = ${:_profile_base_location_}/${:filename}
+
+# download matomo
+# The specific process of downloading and decompressing is defined in stack lamp
+[application]
+url = https://builds.matomo.org/matomo-4.7.1.zip
+md5sum = 8d592676bc2c0d51363ad7b2caf171fe
+
+# give the location of the instance-matomo.cfg fil
+# Without it the instance-matomo.cfg file will not be executed
+[custom-application-deployment]
+path = ${template-matomo-instance:rendered}
+part-list = matomo-backup.sh
+
+[template-matomo-instance]
+recipe = slapos.recipe.template:jinja2
+template = ${:_profile_base_location_}/${:filename}
+rendered = ${buildout:directory}/instance-matomo.cfg
+extensions = jinja2.ext.do
+context =
+          key gzip_location gzip:location
+          key python3_location python3:location
+          key php_location apache-php:location
+          key matomo_apache_httpd template-apache-httpd:target
+          key matomo_backup_sh template-matomo-backup.sh:target
+
+# download apache-httpd.conf.in
+[template-apache-httpd]
+<= matomo-download
+
+# download matomo-backup.sh.in
+[template-matomo-backup.sh] 
+<= matomo-download
+
+

software/matomo/test/README.md

+Tests for matomo software release

software/matomo/test/setup.py

+##############################################################################
+#
+# Copyright (c) 2018 Nexedi SA and Contributors. All Rights Reserved.
+#
+# WARNING: This program as such is intended to be used by professional
+# programmers who take the whole responsibility of assessing all potential
+# consequences resulting from its eventual inadequacies and bugs
+# End users who are looking for a ready-to-use solution with commercial
+# guarantees and support are strongly adviced to contract a Free Software
+# Service Company
+#
+# This program 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.
+#
+# This program 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 this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+#
+##############################################################################
+from setuptools import setup, find_packages
+
+version = '0.0.1.dev0'
+name = 'slapos.test.matomo'
+with open("README.md") as f:
+  long_description = f.read()
+
+setup(
+    name=name,
+    version=version,
+    description="Test for SlapOS' matomo",
+    long_description=long_description,
+    long_description_content_type='text/markdown',
+    maintainer="Nexedi",
+    maintainer_email="info@nexedi.com",
+    url="https://lab.nexedi.com/nexedi/slapos",
+    packages=find_packages(),
+    install_requires=[
+        'slapos.core',
+        'slapos.libnetworkcache',
+        'erp5.util',
+        'requests',
+    ],
+    zip_safe=True,
+    test_suite='test',
+)

software/matomo/test/test.py

+##############################################################################
+# coding: utf-8
+#
+# Copyright (c) 2022 Nexedi SA and Contributors. All Rights Reserved.
+#
+# WARNING: This program as such is intended to be used by professional
+# programmers who take the whole responsibility of assessing all potential
+# consequences resulting from its eventual inadequacies and bugs
+# End users who are looking for a ready-to-use solution with commercial
+# guarantees and support are strongly adviced to contract a Free Software
+# Service Company
+#
+# This program 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.
+#
+# This program 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 this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+#
+##############################################################################
+import os
+import requests
+import glob
+
+from slapos.testing.testcase import makeModuleSetUpAndTestCaseClass
+
+setUpModule, SlapOSInstanceTestCase = makeModuleSetUpAndTestCaseClass(
+    os.path.abspath(
+        os.path.join(os.path.dirname(__file__), '..', 'software.cfg')))
+
+
+class MatomoTestCase(SlapOSInstanceTestCase):
+
+  #check where matomo installed
+  def setUp(self):
+    partition_path_list = glob.glob(os.path.join(self.slap.instance_directory, '*'))
+    for partition_path in partition_path_list:
+      path = os.path.join(partition_path, 'srv/www')
+      if os.path.exists(path):
+        self.matomo_path = path
+        break
+    self.assertTrue(self.matomo_path,"matomo path not found in %r" % (partition_path_list,))
+    self.connection_parameters = self.computer_partition.getConnectionParameterDict()
+
+  #Check if matomo root directory is empty
+  def test_matomo_dir(self):
+    self.assertEqual(os.path.isfile(self.matomo_path),False)
+    
+  #Check deployement matomo works
+  def test_matomo_url_get(self):
+    resp = requests.get(self.connection_parameters['backend-url'], verify=False)
+    self.assertEqual(requests.codes.ok, resp.status_code)
+
+  #Check deployement moniter works
+  def test_monitor_url_get(self):
+    resp = requests.get(self.connection_parameters['monitor-setup-url'], verify=False)
+    self.assertEqual(requests.codes.ok, resp.status_code)
+
+
+

software/slapos-sr-testing/software-py3.cfg

@@ -25,3 +25,4 @@ extra =
   restic-rest-server ${slapos.test.restic_rest_server-setup:setup}
   headless-chromium ${slapos.test.headless-chromium-setup:setup}
   hugo ${slapos.test.hugo-setup:setup}
+  matomo ${slapos.test.matomo-setup:setup}

software/slapos-sr-testing/software.cfg

@@ -145,6 +145,12 @@ setup = ${slapos-repository:location}/software/html5as-base/test/
 egg = slapos.test.hugo
 setup = ${slapos-repository:location}/software/hugo/test/
 
+[slapos.test.matomo-setup]
+<= setup-develop-egg
+egg = slapos.test.matomo
+setup = ${slapos-repository:location}/software/matomo/test/
+
+
 [slapos.test.jupyter-setup]
 <= setup-develop-egg
 egg = slapos.test.jupyter
@@ -282,6 +288,7 @@ extra-eggs =
   ${slapos.test.headless-chromium-setup:egg}
   ${slapos.test.erp5testnode-setup:egg}
   ${slapos.test.hugo-setup:egg}
+  ${slapos.test.matomo-setup:egg}
 
 # We don't name this interpreter `python`, so that when we run slapos node
 # software, installation scripts running `python` use a python without any