Draft: Add tests

conformance-tests/.gitignore

@@ -0,0 +1,7 @@
+testResults/
+build
+.gradle/
+.idea/
+allure-results/
+.venv/
+testtool-out/

conformance-tests/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2023 Fraunhofer ISE
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

conformance-tests/NOTICE

@@ -0,0 +1,18 @@
+Der-scheduling conformance tests
+Copyright 2023 Fraunhofer ISE
+
+This project bundles several dependencies. The project includes:
+
+- asn1bean without modification. It is distributed under Apache-2.0 license.
+  The license can be found under licenses/asn1bean.
+- iec61850bean without modification. It is distributed under Apache-2.0 license.
+  The license can be found under licenses/iec61850bean.
+- commons-io without modification. It is distributed under Apache-2.0 license.
+  The license can be found under licenses/commons-io.
+- slf4j-api without modification. It is distributed under the MIT license. The license can be found under licenses/SLF4J.
+- logback-core without modification. It is distributed under a dual EPL v1.0/LGPL 2.1 license.
+   It is included into this project under EPL v1.0 The license can be found under licenses/LOGBACK.
+- logback-classic without modification. It is distributed under a dual EPL v1.0/LGPL 2.1 license.
+   It is included into this project under EPL v1.0 The license can be found under licenses/LOGBACK.
+
+For the exact (maven) references, see build.gradle file under 'dependencies'.

conformance-tests/README.md

@@ -0,0 +1,49 @@
+# Alliander rfg+ conformance tests
+
+This project is aiming for testing the scheduling functions of an existing implementation against
+the [requirements](../REQUIREMENTS.md).
+
+To link the [tests](main/src/test/java/org/openmuc/fnn/steuerbox/)
+to their requirements, the requirements are being copied
+into [a java class](src/main/java/org/openmuc/fnn/steuerbox/models/Requirement.java)
+such that they can be referenced in the javadoc of the tests. A java IDE (
+e.g. [intelliJ](https://www.jetbrains.com/idea/)) will render this in a way that references can be followed
+bidirectionally.
+
+## License
+
+This test framework is licensed under Apache 2.0 license. It uses dependencies licensed under
+
+- Eclipse Public license 1.0
+- MIT license
+- Apache 2.0 license 
+
+see [NOTICE](NOTICE) for details.
+
+## Running the tests
+
+The tests will later on run with JUnit, a common testing framework for java. They can be started by
+calling `./gradlew test` for linux systems or `gradlew.bat test` in Windows.
+
+# Test setup
+
+Tested runtime environment is openjdk 11. The test assumes the test device is running on localhost (127.0.0.1) and
+accessible on port 102. [This is currently hard coded.](test/tests/src/main/java/org/openmuc/fnn/steuerbox/models/AllianderDER.java#L17)
+
+## Test results
+
+[Allure](https://github.com/allure-framework) will be used to create readable test reports with more information.
+
+Also, the testResults folder contains the logs of all tests, these might be useful for debugging.
+
+## Getting started
+
+For a first impression, it probably makes sense to have a look in the very
+incomplete [requirements](src/main/java/org/openmuc/fnn/steuerbox/models/Requirement.java)
+and the
+general [IEC 61850 scheduling execution tests](tests/src/test/java/org/openmuc/fnn/steuerbox/ScheduleExecutionTest.java)
+, tests on existing IEC 61850
+nodes [of schedule controller](src/test/java/org/openmuc/fnn/steuerbox/ScheduleControllerNodeTests.java)
+and [schedule](src/test/java/org/openmuc/fnn/steuerbox/ScheduleNodeTests.java) and more
+[Alliander spcific tests](main/src/test/java/org/openmuc/fnn/steuerbox/AllianderTests.java)
+.

conformance-tests/allowed-licenses.json

@@ -0,0 +1,38 @@
+{
+  "allowedLicenses": [
+    {
+      "moduleLicense": "The Apache License, Version 2.0"
+    },
+    {
+      "moduleLicense": "Apache License, Version 2.0"
+    },
+    {
+      "moduleLicense": "Apache 2.0"
+    },
+    {
+      "moduleLicense": "The Apache Software License, Version 2.0"
+    },
+    {
+      "comment": "MIT can be included into Apache 2.0 according    https://www.apache.org/legal/resolved.html#category-a (31.1.23)",
+      "moduleLicense": "MIT License",
+      "moduleVersion": "2.0.13",
+      "moduleName": "org.slf4j:slf4j-api"
+    },
+    {
+      "comment": "uses dual license, we use Eclipse Public License - v 1.0 which can be included into Apache 2.0 according to https://www.apache.org/legal/resolved.html#category-b (31.1.23)",
+      "moduleVersion": "1.5.6",
+      "moduleName": "ch.qos.logback:logback-core"
+    },
+    {
+      "comment": "uses dual license, we use Eclipse Public License - v 1.0 which can be included into Apache 2.0 according to https://www.apache.org/legal/resolved.html#category-b (31.1.23)",
+      "moduleVersion": "1.5.6",
+      "moduleName": "ch.qos.logback:logback-classic"
+    },
+    {
+      "comment": "MIT can be included into Apache 2.0 according    https://www.apache.org/legal/resolved.html#category-a (03.06.2024)",
+      "moduleLicense": "MIT-0",
+      "moduleVersion": "1.0.4",
+      "moduleName": "org.reactivestreams:reactive-streams"
+    }
+  ]
+}

conformance-tests/build.gradle

@@ -0,0 +1,55 @@
+//#############################################################################
+//Global configuration
+//#############################################################################
+
+
+plugins {
+    id 'java-library'
+    id 'com.github.jk1.dependency-license-report' version '2.8'
+}
+repositories {
+    mavenCentral()
+}
+dependencies {
+    implementation 'ch.qos.logback:logback-classic:1.5.6'
+    implementation group: 'org.slf4j', name: 'slf4j-api', version: '2.0.13'
+
+    implementation("com.fasterxml.jackson.core:jackson-databind:2.17.1")
+
+    implementation group: 'com.beanit', name: 'iec61850bean', version: '1.9.0'
+    implementation group: 'commons-io', name: 'commons-io', version: '2.16.1'
+
+    testImplementation 'org.junit.jupiter:junit-jupiter-api:5.10.2'
+    testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.10.2'
+    testImplementation 'org.junit.jupiter:junit-jupiter-params:5.10.2'
+
+    implementation("com.hivemq:hivemq-mqtt-client:1.3.3")
+}
+
+jar {
+    manifest {
+        attributes(
+                'Main-Class': 'org.openmuc.fnn.steuerbox.ScheduleWriterExample'
+        )
+    }
+    from {
+        configurations.runtimeClasspath.collect { it.isDirectory() ? it : zipTree(it) }
+    }
+}
+
+test {
+    useJUnitPlatform()
+}
+
+
+import com.github.jk1.license.render.XmlReportRenderer
+
+licenseReport {
+    outputDir = "$projectDir/build/licenses"
+    configurations = ['runtimeClasspath']
+    excludeOwnGroup = true
+    excludeBoms = false
+    renderers = [new XmlReportRenderer('third-party-libs.xml', 'Back-End Libraries')]
+    allowedLicensesFile = new File("$projectDir/allowed-licenses.json")
+}
+

conformance-tests/checkLicense.sh

@@ -0,0 +1,10 @@
+#!/bin/bash
+# Skript to check proper licensing setup
+
+./gradlew clean checkLicense
+
+# check that java files have Apache2.0 license header
+APACHE_2_LICENSE="Licensed under the Apache License, Version 2.0"
+echo "the following files do not have a proper header:"
+find ./ -iname "*.java" -print  | xargs grep -L "$APACHE_2_LICENSE"
+echo "<end of list>"

conformance-tests/gradle/wrapper/gradle-wrapper.properties

@@ -0,0 +1,5 @@
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.6.4-bin.zip
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists