Osie's coupler SRs

See merge request nexedi/slapos!1333

component/mbedtls/buildout.cfg

 [buildout]
+extends =
+  ../cmake/buildout.cfg
 parts = mbedtls
 
 [mbedtls]
@@ -6,5 +8,8 @@ recipe = slapos.recipe.cmmi
 url = https://github.com/Mbed-TLS/mbedtls/archive/refs/tags/v2.28.2.tar.gz
 md5sum = 421c47c18ef46095e3ad38ffc0543e11
 shared = true
-configure-command = echo 
+configure-command = cmake -DUSE_SHARED_MBEDTLS_LIBRARY=On -DCMAKE_INSTALL_PREFIX=
+environment =
+  PATH=${cmake:location}/bin:%(PATH)s
+  LDFLAGS=-Wl,-rpath=@@LOCATION@@/lib/
 make-targets = install DESTDIR=@@LOCATION@@

software/osie-coupler/buildout.hash.cfg

+[instance-profile]
+filename = instance.cfg.in
+md5sum = fa8d1d0a44720e0ffa4f6a953b65eae4

software/osie-coupler/instance-input-schema.json

+{
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "description": "Parameters to instantiate coupler",
+  "type": "object",
+  "configuration": {
+
+  "coupler_block_device": {
+      "description": "The Linux block device using I2C protocol,",
+      "type": "string",
+      "default": "/dev/i2c-1"
+    },
+
+  "coupler_i2c_slave_list": {
+      "description": "The list of comma separated addresses of I2C enabled devices on the I2C bus.",
+      "type": "string",
+      "default": "0x58"
+    },
+
+  "opc_ua_port": {
+      "description": "The OPC UA server bind to bind to.",
+      "type": "integer",
+      "default": 4840
+  },
+
+  "mode": {
+      "description": "The operationg mode of the coupler. By default 0 - i.e. control for real I2C devices attached. If 1 selected emulate them (useful for testing). ",
+      "type": "integer",
+      "default": 0
+  },
+
+  "id": {
+      "description": "The numeric ID of the coupler",
+      "type": "integer",
+      "default": 0
+  },
+
+  "username": {
+      "description": "The username for OPC UA server.",
+      "type": "string",
+      "default": ""
+    },
+
+  "password": {
+      "description": "The password for OPC UA server.",
+      "type": "string",
+      "default": ""
+    },
+
+  "heart_beat": {
+      "description": "Indication if coupler should send heart beats over a keep-alive network.",
+      "type": "boolean",
+      "default": 0
+    },
+
+  "heart_beat_interval": {
+      "description": "The heart beat interval (in ms)",
+      "type": "integer",
+      "default": 500
+    },
+
+  "heart_beat_id_list": {
+      "description": "A comma separated list of couplers' IDs which should send to us keep-alive messages. ",
+      "type": "string",
+      "default": ""
+    },
+
+  "heart_beat_timeout_interval": {
+      "description": "The timeout (in ms) which when expired without a keep alive message will cause the coupler to go to a safe mode. ",
+      "type": "integer",
+      "default": 2000
+    },
+
+  "network_address_url_data_type": {
+      "description": "Network address URL type used for Pub/Sub.",
+      "type": "string",
+      "default": "opc.udp://224.0.0.22:4840/"
+    }
+
+  }
+}

software/osie-coupler/instance-output-schema.json

+{
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "description": "Values returned by coupler's instantiation.",
+  "additionalProperties": false,
+  "properties": {},
+  "type": "object"
+}

software/osie-coupler/instance.cfg.in

+#############################
+#
+# Deploy coupler instance
+#
+#############################
+[buildout]
+parts =
+  directory
+  publish-connection-parameter
+  coupler-opc-ua
+
+eggs-directory = {{ buildout['eggs-directory'] }}
+develop-eggs-directory = {{ buildout['develop-eggs-directory'] }}
+offline = true
+extends = {{ template_monitor }}
+
+[coupler-opc-ua]
+recipe = slapos.cookbook:wrapper
+environment =
+  LD_LIBRARY_PATH=$LD_LIBRARY_PATH:{{ open62541_location }}/lib:{{ mbedtls_location }}/lib
+command-line =
+    {{ coupler_location }}/server -d ${instance-parameter:configuration.coupler_block_device} -s ${instance-parameter:configuration.coupler_i2c_slave_list} -p ${instance-parameter:configuration.opc_ua_port} -u ${instance-parameter:configuration.username} -w ${instance-parameter:configuration.password} -b ${instance-parameter:configuration.heart_beat} -t ${instance-parameter:configuration.heart_beat_interval} -l ${instance-parameter:configuration.heart_beat_id_list} -n ${instance-parameter:configuration.network_address_url_data_type} -o ${instance-parameter:configuration.heart_beat_timeout_interval} -i ${instance-parameter:configuration.id} -m ${instance-parameter:configuration.mode}
+wrapper-path = ${directory:service}/coupler-opc-ua
+
+[instance-parameter]
+recipe = slapos.cookbook:slapconfiguration
+computer = ${slap-connection:computer-id}
+partition = ${slap-connection:partition-id}
+url = ${slap-connection:server-url}
+key = ${slap-connection:key-file}
+cert = ${slap-connection:cert-file}
+configuration.coupler_block_device = /dev/i2c-1
+configuration.coupler_i2c_slave_list = 0x58
+configuration.mode = 0
+configuration.username =
+configuration.password =
+configuration.interface = 0.0.0.0
+configuration.opc_ua_port = 4840
+configuration.id = 0
+configuration.heart_beat = 0
+configuration.heart_beat_interval = 500
+configuration.heart_beat_id_list =
+configuration.network_address_url_data_type = opc.udp://224.0.0.22:4840/
+configuration.heart_beat_timeout_interval = 2000
+
+[directory]
+recipe = slapos.cookbook:mkdirectory
+home = ${buildout:directory}
+etc = ${:home}/etc
+var = ${:home}/var
+script = ${:etc}/run/
+service = ${:etc}/service
+log = ${:var}/log
+
+[publish-connection-parameter]
+recipe = slapos.cookbook:publish
+opc_ua_port = ${instance-parameter:configuration.opc_ua_port}
+interface = ${instance-parameter:configuration.interface}

software/osie-coupler/software.cfg

+[buildout]
+parts =
+  open62541
+  compile-coupler
+  slapos-cookbook
+  instance-profile
+
+extends =
+  ../../component/git/buildout.cfg
+  ../../component/mbedtls/buildout.cfg
+  ../../component/open62541/buildout.cfg
+  ../../stack/monitor/buildout.cfg
+  ../../stack/slapos.cfg
+
+# we need open62541's sources even after compiling and linking in [open62541]
+# section. Reasons is that coupler's C application depends on it.
+[open62541-source]
+recipe = slapos.recipe.build:download-unpacked
+shared = true
+url = ${open62541:url}
+md5sum = ${open62541:md5sum}
+
+[open62541]
+configure-options =
+  -DBUILD_SHARED_LIBS=ON
+  -DCMAKE_BUILD_TYPE=Release
+  -DCMAKE_INSTALL_PREFIX=@@LOCATION@@
+  -DUA_ENABLE_PUBSUB=ON
+  -DUA_ENABLE_PUBSUB_MONITORING=ON
+  -DUA_ENABLE_PUBSUB_ETH_UADP=ON
+  -DUA_NAMESPACE_ZERO=REDUCED
+  -DUA_ENABLE_ENCRYPTION=MBEDTLS
+  -DUA_ENABLE_ENCRYPTION_MBEDTLS=ON
+  -DMBEDTLS_INCLUDE_DIRS=${mbedtls:location}/include
+  -DMBEDTLS_LIBRARY=${mbedtls:location}/lib/libmbedtls.so
+  -DMBEDX509_LIBRARY=${mbedtls:location}/lib/libmbedx509.so
+  -DMBEDCRYPTO_LIBRARY=${mbedtls:location}/lib/libmbedcrypto.so
+  -DUA_ENABLE_PUBSUB_INFORMATIONMODEL=ON
+  -DUA_ENABLE_PUBSUB_MQTT=ON
+environment +=
+  LDFLAGS=-L${mbedtls:location}/lib -Wl,-rpath=${mbedtls:location}/lib
+
+[osie-repository]
+recipe  = slapos.recipe.build:gitclone
+git-executable = ${git:location}/bin/git
+repository = https://lab.nexedi.com/nexedi/osie.git
+revision = 35228392c4f2eb24eee478cd98349e0f613a4ff2
+
+[compile-coupler]
+recipe = slapos.recipe.cmmi
+path = ${osie-repository:location}/coupler/opc-ua-server/
+bin_dir = ${:path}/bin/
+environment =
+  OPEN62541_HOME = ${open62541:location}
+  OPEN62541_SOURCE_HOME = ${open62541-source:location}
+  C_COMPILER_EXTRA_FLAGS = -L ${mbedtls:location}/lib -Wl,-rpath=${mbedtls:location}/lib -l:libopen62541.so -L${open62541:location}/lib -Wl,-rpath=${open62541:location}/lib -I${open62541:location}/include -I${open62541-source:location}/src/pubsub/ -I${open62541-source:location}/deps
+configure-command = true
+
+[instance-profile]
+recipe = slapos.recipe.template:jinja2
+template = ${:_profile_base_location_}/instance.cfg.in
+mode = 0644
+rendered = ${buildout:directory}/instance.cfg
+extensions = jinja2.ext.do
+context =
+  section buildout buildout
+  raw template_monitor ${monitor2-template:output}
+  key open62541_location open62541:location
+  key mbedtls_location mbedtls:location
+  key coupler_location compile-coupler:bin_dir

software/osie-coupler/software.cfg.json

+{
+  "name": "OSIE coupler",
+  "description": "Coupler is an open source thin C client application supporting OPC UA protocol and used in conjunction with beremiz-ide / beremiz-runtime to control industrial processes on the shop field.",
+  "serialisation": "xml",
+  "software-type": {
+    "default": {
+      "title": "Default",
+      "software-type": "default",
+      "description": "Default",
+      "request": "instance-input-schema.json",
+      "response": "instance-output-schema.json"
+    }
+  }
+}

software/osie-coupler/test/README.md

+Tests for osie-coupler software release

software/osie-coupler/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.osie-coupler'
+with open("README.md") as f:
+  long_description = f.read()
+
+setup(
+    name=name,
+    version=version,
+    description="Test for SlapOS' Osie Coupler",
+    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',
+    ],
+    zip_safe=True,
+    test_suite='test',
+)

software/osie-coupler/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
+
+from slapos.testing.testcase import makeModuleSetUpAndTestCaseClass
+
+setUpModule, SlapOSInstanceTestCase = makeModuleSetUpAndTestCaseClass(
+    os.path.abspath(
+        os.path.join(os.path.dirname(__file__), '..', 'software.cfg')))
+
+class OsieTestCase(SlapOSInstanceTestCase):
+
+  @classmethod
+  def getInstanceParameterDict(cls):
+    return {"mode": 1}
+
+  def test(self):
+    connexion_parameters = self.computer_partition.getConnectionParameterDict()
+    self.assertIn('opc_ua_port', connexion_parameters)
+    self.assertIn('interface', connexion_parameters)

software/slapos-sr-testing/software.cfg

@@ -257,6 +257,11 @@ setup = ${slapos-repository:location}/software/peertube/test/
 egg = slapos.test.js_drone
 setup = ${slapos-repository:location}/software/js-drone/test/
 
+[slapos.test.osie-coupler-setup]
+<= setup-develop-egg
+egg = slapos.test.osie_coupler
+setup = ${slapos-repository:location}/software/osie-coupler/test/
+
 [slapos.core-repository]
 <= git-clone-repository
 repository = https://lab.nexedi.com/nexedi/slapos.core.git
@@ -333,6 +338,7 @@ eggs +=
   ${slapos.test.nextcloud-setup:egg}
   ${slapos.test.nginx-push-stream-setup:egg}
   ${slapos.test.ors-amarisoft-setup:egg}
+  ${slapos.test.osie-coupler-setup:egg}
   ${slapos.test.peertube-setup:egg}
   ${slapos.test.plantuml-setup:egg}
   ${slapos.test.powerdns-setup:egg}
@@ -425,6 +431,7 @@ tests =
   nextcloud ${slapos.test.nextcloud-setup:setup}
   nginx-push-stream ${slapos.test.nginx-push-stream-setup:setup}
   ors-amarisoft ${slapos.test.ors-amarisoft-setup:setup}
+  osie-coupler ${slapos.test.osie-coupler-setup:setup}
   peertube ${slapos.test.peertube-setup:setup}
   plantuml ${slapos.test.plantuml-setup:setup}
   powerdns ${slapos.test.powerdns-setup:setup}