Sct initial push

.github/workflows/sonarcloud-analysis.yml

@@ -1,4 +1,4 @@
-# SPDX-FileCopyrightText: 2021 Alliander N.V.
+# SPDX-FileCopyrightText: 2020 Alliander N.V.
 #
 # SPDX-License-Identifier: Apache-2.0
 
@@ -7,15 +7,41 @@ name: SonarCloud Analysis
 on: push
 
 jobs:
-  sonarcloud:
-    name: SonarCloud
+  build:
+    name: Build
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
         with:
-          fetch-depth: 0  # Shallow clones should be disabled for a better relevancy of analysis
-      - name: SonarCloud Scan
-        uses: SonarSource/sonarcloud-github-action@master
+          fetch-depth: 0
+      - name: Set up JDK 11
+        uses: actions/setup-java@v1
+        with:
+          java-version: 11
+      - name: Cache SonarCloud packages
+        uses: actions/cache@v1
+        with:
+          path: ~/.sonar/cache
+          key: ${{ runner.os }}-sonar
+          restore-keys: ${{ runner.os }}-sonar
+      - name: Cache Maven packages
+        uses: actions/cache@v1
+        with:
+          path: ~/.m2
+          key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
+          restore-keys: ${{ runner.os }}-m2
+      - name: Create custom Maven Settings.xml
+        uses: whelk-io/maven-settings-xml-action@v18
+        with:
+          output_file: custom_maven_settings.xml
+          servers: '[{ "id": "github-packages-compas", "username": "OWNER", "password": "${{ secrets.GITHUB_TOKEN }}" }]'
+      - name: Build and analyze
         env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+        run: |
+          mvn -B -s custom_maven_settings.xml \
+            -Dsonar.projectKey=com-pas_compas-sct \
+            -Dsonar.organization=com-pas \
+            -Dsonar.host.url=https://sonarcloud.io \
+            verify org.sonarsource.scanner.maven:sonar-maven-plugin:sonar

.gitignore

@@ -0,0 +1,37 @@
+# SPDX-FileCopyrightText: 2020 RTE FRANCE
+#
+# SPDX-License-Identifier: Apache-2.0
+
+HELP.md
+target/
+.scannerwork
+sonar-project.properties
+!.mvn/wrapper/maven-wrapper.jar
+!**/src/main/**
+!**/src/test/**
+
+### STS ###
+.apt_generated
+.classpath
+.factorypath
+.project
+.settings
+.springBeans
+.sts4-cache
+
+### IntelliJ IDEA ###
+.idea
+*.iws
+*.iml
+*.ipr
+
+### NetBeans ###
+/nbproject/private/
+/nbbuild/
+/dist/
+/nbdist/
+/.nb-gradle/
+build/
+
+### VS Code ###
+.vscode/

.reuse/dep5

@@ -0,0 +1,12 @@
+Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
+Upstream-Name: compas-sct
+Upstream-Contact: Mohamed SYLLA <mohamed.sylla@rte-france.com>
+Source: https://github.com/com-pas/compas-sct
+
+Files: doc/images/*
+Copyright: 2021 RTE FRANCE
+License: Apache-2.0
+
+Files: doc/drawio/*
+Copyright: 2021 RTE FRANCE
+License: Apache-2.0

doc/compas-sct.md

@@ -0,0 +1,104 @@
+<!-- SPDX-FileCopyrightText: 2021 RTE FRANCE -->
+<!-- -->
+<!-- SPDX-License-Identifier: Apache-2.0 -->
+# COMPAS SCT (Substation Configuration Tool)
+## Introduction
+
+The CoMPAS SCT (System Configuration Tool) is part of the CoMPAS (Configuration Module for Power System Automation)
+ecosystem which is an open source project aimed at providing a tool for configuring control system and 
+profile management related to the 61850 standard. Its architecture allows an easy integration with the other 
+components of CoMPAS, in addition to being modular and flexible with a high level of abstraction, it gives 
+the freedom to implement the tool with the database of its choice.
+
+The below package diagram shows different part of the tool architecture. 
+
+![Package Diagram](images/PackageDiagram-CompasSCT.png)
+
+Hence, we can distinguish four major parts:
+
+* **[sct-commons](#SCT-COMMONS)** : a library that contents shared functionalities for the bound SCL object.
+* **[sct-service](#SCT-SERVICE)** : It computes all needed operations and uses sct-data for database access.
+* **[sct-data](#SCT-DATA)** : It holds data models and database connectivity services.
+* **[sct-app](#SCT-APPLICATION)** : *TODO*.
+
+## SCT COMMONS
+This package holds a light weight and configurable XML binding tool based on the JAXB utilities, and set of bound SCL 
+objects adapter. Actually the JAXB generated SCL objects can only be read through from the parent tag to child tag. That can be very limiting.
+The adapter concept allows:
+* navigating in all direction (upward, downward)
+* more flexible manipulation of the JAXB SCL object
+* considering specific algorithm based on SCL version
+
+The SCT services specification of the norm IEC 61850  will be implemented in this package.
+
+The Approach behind the SCL adapter is to complete the navigation provided by the JAXB tool, by adding 
+functionalities that allow the browsing upward (from child to any ancestor). The conception is based on the 
+abstraction defined below :
+
+    public abstract class SclElementAdapter<P extends SclElementAdapter, T> {
+        protected P parentAdapter;
+        protected T currentElem;
+
+        public SclElementAdapter(P parentAdapter) {
+            this.parentAdapter = parentAdapter;
+        }
+
+        public SclElementAdapter(P parentAdapter, T currentElem) {
+            this.parentAdapter = parentAdapter;
+            setCurrentElem(currentElem);
+        }
+
+        public final void setCurrentElem(T currentElem){
+            Assert.isTrue(amChildElementRef(currentElem),"No relation between SCL parent and child elements");
+            this.currentElem = currentElem;
+        }
+
+        protected abstract boolean amChildElementRef(T sclElement);
+    }
+
+The root element adapter (entry point) is special as it does not have any parent adapter, hence, its method `amChildElementRef(T)` 
+should always return `true`:
+
+    public class SclRootAdapter extends SclElementAdapter<SclRootAdapter, SCL>{
+        private version;
+        private revision;
+        private release;
+
+        public SclRootAdapter(SCL currentElem) {
+            super(null, currentElem);
+            //set version, release & revision
+        }
+
+        public SclRootAdapter(String hId, String hVersion, String hRevision){
+            super(null);
+            this.currentElem = initialize(hId,hVersion,hRevision);
+        }
+
+        @Override
+        protected boolean amChildElementRef(SCL sclElement) {
+            return true;
+        }
+
+        [...]
+    }
+
+
+
+## SCT DATA
+Data models and connectivity to database are defined here. Data access layer is an abstract layer that defined connectivity
+interfaces. This layer manages a database with single table (SQL-Like database) or single collection (NoSQL-Like database).
+The concrete data access layers are implemented in specific packages
+
+* ### SQL-Like Database
+An implementation of the sct-data connectivity interface with custom data models. This allows the application to work with sql-like database.
+The libraries ares use for SQL-Like databases, those that support XML type (PostgreSql, Oracle, etc)
+
+* ### NoSQL-Like Database
+Like SQL-like part, this package contains the sct-data connector interfaces implementation for NoSQL-Like databases (BaseX, existDB, etc ) 
+that support XML processing
+
+## SCT SERVICE
+This module implements all needed specification as functions (methods in Java). As shown in package diagram, 
+it interacts with sct-data (database access) and sct-commons (delegate SCL manipulation).
+## SCT APPLICATION
+**TODO**

doc/drawio/compas-sct.drawio

@@ -0,0 +1 @@
+<mxfile host="app.diagrams.net" modified="2021-08-23T14:01:51.473Z" agent="5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/92.0.4515.107 Safari/537.36 Edg/92.0.902.55" etag="uZeMYTGyEtbajDSc3TgE" version="14.9.8" type="device"><diagram id="3wWlgGhNNHLo4Hu9hpyk" name="Page-1">7Vtbd5s4EP41Pmf3wT1I4vqYOHa3Z3vJ1t2z7VMPBtnmFBALcu30168Ekg0IfEkwdjbJS9BIyNJ83wwzIxigUbR5m7rJ8gPxcTiAmr8ZoLsBhADYkP3jkodCYiEhWKSBLwbtBNPgFxZCTUhXgY+zykBKSEiDpCr0SBxjj1ZkbpqSdXXYnITVX03cBVYEU88NVek/gU+XhdSG1k7+Bw4WS/nLwHSKnsiVg8VOsqXrk3VJhMYDNEoJocVVtBnhkCtP6qW4b9LSu11YimN6zA1ROLbej79P3iXfI+Pj57dr8vbdEInF/XTDldjx6NOH+5upWDN9kIpgy0/45SoKJ6kbscvb9TKgeJq4HpevGf5MtqRRyFqAXc6DMByRkKT5BMjXPIzZrm8zmpIfuNRjmAaw+ITZOohCN8aT6p13+hhMDNYv1opTijetWgBb3TJSYhJhmj6wIfIGXexY8FE21ztwTUvIliVgDd0QpBKEWmyn3umcXQi1nwIBaIFgOB196QAGuTPA+ME65J6QpkI0n8+h5zVB5Jsz0zDbIZrnfx1BZFUhclSIdK0BIt3QzgURbINo9OnzuEuMUAWjHLEWjY/BnTG2VAwdZzSaTLpBwoRVJKChQgHMBiigdTYokAJF5tGhR6KIxFkrFNzv45Rri8R0Kvq55jOGSRAvvpCEC7i+qTuTnl4X7a2HB3ohuCdZQAMSM1GI53S/3zOw7etNRmXDGTLNbqDSTaMCFQLwjaGA5TR5trNBpTdC5bvUfbk4QbtqUshUTarx+XM2lIxWlIbJ4uUCBRy9Gig0+L5+gTLbgZptrgKoLvwYMK9M7Vaj2jOc/gzY0/wa1H4ZR2aab6qPHHBxqOxGqNwkGUAz5Eqbpexqwa9+c1eUsByN65QtJUl+f7lQ6vAwkAD2iqSjIPl3phobjv0bnuOzFkkw0+gtk4gaAuCppu9mS+wL3ZbUjDcB/cqutTeGaH0r9dxxvWiy8VBq3OM0YDvkbChkMdvt13LjW7mRTwR3zYdyZ32uYnfYV+oRNRiZBsgq9fARPou66QLTgyGaSoym+D7FITOXn9XVNSEvprsnAVt3a+K9zS3kFMWuxF3lOkZtIqQdmKjYtTJRTsTtHh/PTbmPV24+jpv2sdxEr9w8mZtqLek83CwxU2tlJoJPoKZVpWYx19Vw03rl5sncVIto+4g5C4n3o05F1s/LYFuyVEhb5umWYIUTlRQDFYod6fw4tWTYR1K6JAsSu+F4Jz2Bgtf0RN6esdRTrb6YxaB2H0rDEj4gO33BbetSxuv7xyNg7BvPLooVd2sWakFzn1nEJMZPcdDwqNihS59qHiS0sSe16Np71gvTR3O8hUtdc1xHZuPvtK7LOpHjxt7xZ+K4WgmWGTnPqQf8+FZmtua/K34iyiiIWGLqQFwWaZk8IJYyUO4uUns5NUvP44odyYH8N4drQbYbNiQ/Tip4r+UnNcOsOKrhnTFJIzfc9uc3F8vgvQAmG3UJmRdCTbNmulwLU1uxnOoSmbhQgBRfQQli8PSCglkvcl+6MqSrRe5+42Knu8D4EnExOjJ60S9YTwBdRS/1ic4dF++p6w+s281mM7DursIzXKbO7NSCsgZfYht9+hL1QOApAdtFqjSHDfmiUVtbIH6ybQPnwratnki4Mdejt8ooidjFXftDPyaUM+fAqyMiIsoNmBta4LnhTRgsuAlTbvy3rmgJg644hmFHVopq3thoeK8KgAbG1FPF7sxUPULoxEw7KCh0+GTWj61YXdaglYe1+UwNWurjYoGkdVwg2SHFeqxIGfLlWfm+mWM9jiZKAuLAfmnyv63D58+Zq8k3+uSmVeUm0h7JTauWb+haz9yEF+bmcSXIaz2+PPZo/SWlwicX8m278jsA7S9amrUi56HxdROrjT9PkdPot5APYP+RgH2Q0s8hhlTYIb9R6ssBq9XwJgfMkrFa/aVaZxEEKhdlhEgmfB5DOK8N1fPCKPD9sC23TMkq9nNK7ujztGpw7egEmOqL6XqfqaGhVoMV7e+0AA7n4ISn1DQ3w4avajr9fMmuHQ8hNc+GmqMq0zmbMtXy5XNRpl6PxBqU2fh5y/mU2VRbPHxQprG/+Vw9hpr+9X74/t2f40FRZzruzOk6/M6OBUZHbmjr5iXaQEXbsvt0Q2px8ClgfySvcO95qbkJbgAaDg4egTdr7r7jLcKE3dfQaPwf</diagram></mxfile>

pom.xml

@@ -0,0 +1,80 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- SPDX-FileCopyrightText: 2020 RTE FRANCE -->
+<!-- -->
+<!-- SPDX-License-Identifier: Apache-2.0 -->
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <groupId>org.lfenergy.compas</groupId>
+    <artifactId>compas-sct</artifactId>
+    <version>local-SNAPSHOT</version>
+    <packaging>pom</packaging>
+    <name>COMPAS-SCT</name>
+
+    <repositories>
+        <repository>
+            <id>github-packages-compas</id>
+            <name>Github Packages CoMPAS</name>
+            <url>https://maven.pkg.github.com/com-pas/*</url>
+        </repository>
+    </repositories>
+
+    <properties>
+        <compas.core.version>local-SNAPSHOT</compas.core.version>
+        <maven.compiler.target>11</maven.compiler.target>
+        <maven.compiler.source>11</maven.compiler.source>
+        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+        <sonar.coverage.exclusions>sct-coverage/**</sonar.coverage.exclusions>
+        <aggregate.report.dir>../sct-coverage/target/site/jacoco-aggregate/jacoco.xml</aggregate.report.dir>
+        <sonar.coverage.jacoco.xmlReportPaths>${basedir}/${aggregate.report.dir}</sonar.coverage.jacoco.xmlReportPaths>
+    </properties>
+
+    <dependencies>
+        <dependency>
+            <groupId>org.lfenergy.compas.core</groupId>
+            <artifactId>scl2007b4</artifactId>
+            <version>0.2.1</version>
+        </dependency>
+    </dependencies>
+    <modules>
+        <module>sct-commons</module>
+        <module>sct-coverage</module>
+    </modules>
+
+    <build>
+        <pluginManagement>
+            <plugins>
+                <plugin>
+                    <groupId>org.apache.maven.plugins</groupId>
+                    <artifactId>maven-compiler-plugin</artifactId>
+                    <version>3.8.1</version>
+                </plugin>
+                <plugin>
+                    <groupId>org.jacoco</groupId>
+                    <artifactId>jacoco-maven-plugin</artifactId>
+                    <version>0.8.6</version>
+                </plugin>
+            </plugins>
+        </pluginManagement>
+
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-compiler-plugin</artifactId>
+            </plugin>
+            <plugin>
+                <groupId>org.jacoco</groupId>
+                <artifactId>jacoco-maven-plugin</artifactId>
+                <executions>
+                    <execution>
+                        <id>prepare-agent</id>
+                        <goals>
+                            <goal>prepare-agent</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
+        </plugins>
+    </build>
+</project>