add protocol

LICENSE

+GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

Protocol/protocol/authenticating/capabilities.py

+import protocol.basic.metadata as metadata
+
+
+def server() -> dict:
+    """
+    Function Description:
+        Create capabilities structure
+    """
+    capabilities = {
+        "type": "capabilities",
+        "jani-version": 1,
+        "extensions": [],
+        "metadata": metadata.server(),
+        "roles": ["analyse", "transform"],
+    }
+    return capabilities

Protocol/protocol/basic/anyModel.py

+from os import listdir
+from os.path import join
+
+
+def createPINS(path: str) -> dict:
+    """
+    Function Description:
+        Create PINS model datastructure, from existing PINS model
+
+    Function Parameters:
+        path: str
+            Path to PINS implementation folder
+    """
+    parts = []
+    # Reading all files in directory and add them as "part" to model
+    for codeFile in listdir(path):
+        location = join(path, codeFile)
+        with open(location, "r") as code:
+            name, role = codeFile.split(".")
+            if role == "c":
+                role = "source-code"
+            elif role == "h":
+                role = "header"
+            parts.append({"name": name, "role": role, "part": code.read()})
+    pins = {"name": "PINS", "parts": parts}
+    return pins

Protocol/protocol/basic/extension.py

+def supported() -> list:
+    # In the jani-interaction protocol (version 1) extensions aren't fully defined, yet.
+    return []

Protocol/protocol/basic/metadata.py

+import protocol.basic.version as version
+
+
+def server() -> dict:
+    """
+    Function Description:
+        Create metadata for JANI2PINS server
+    """
+    metadata = {
+        "name": "JANI - Server LTSmin",
+        "version": version.create(0, 1, 2),
+        "author": "Lars Schieffer",
+        "description": "Implementation of the JANI interaction-protocol with LTSmin support",
+    }
+    return metadata
+
+
+def analysisEngine() -> dict:
+    """
+    Function Description:
+        Create metadata for analysis engine
+    """
+    metadata = {
+        "name": "JANI2PINS - Analysis Engine",
+        "version": version.create(0, 1, 2),
+        "author": "Lars Schieffer",
+        "description": "Engine for performing model checking of JANI models with LTSmin",
+    }
+    return metadata
+
+
+def modelTransformer() -> dict:
+    """
+    Function Description:
+        Create metadata for model transformer
+    """
+    metadata = {
+        "name": "JANI2PINS - Model Transformer",
+        "version": version.create(0, 1, 2),
+        "author": "Lars Schieffer",
+        "description": "Model transformer for JANI models to produce PINS models",
+    }
+    return metadata

Protocol/protocol/basic/modelFeatures.py

+def supported() -> list:
+    """
+    Function Description:
+        Supported JANI model features by JANI2PINS server
+    """
+    return ["derived-operators", "functions"]

Protocol/protocol/basic/modelTypes.py

+def supported() -> list:
+    """
+    Function Description:
+        Supported model types by JANI2PINS server
+    """
+    return ["lts", "mdp"]

Protocol/protocol/basic/modellingFormalisms.py

+def supported() -> list:
+    """
+    Function Description:
+        Supported model formalisms by JANI2PINS server
+    """
+    return ["PINS"]

Protocol/protocol/basic/version.py

+def create(major: int, minor: int, revision: int) -> dict:
+    """
+    Function Description:
+        Create version structure
+
+    Function Parameters:
+        major: int
+            Major value of version structure
+        minor: int
+            Minor value of version structure
+        revision: int
+            Revision value of version structure
+    """
+    return {"major": major, "minor": minor, "revision": revision}

Protocol/protocol/close.py

+def message(reason: str) -> dict:
+    """
+    Function Description:
+        Connection close message
+
+    Function Parameters:
+        reason: str
+            Provide reason, why connection is closed
+    """
+    close = {"type": "close", "reason": reason}
+    return close

Protocol/protocol/connected/authenticate.py

+supportedVersion = 1
+
+
+def valid(authenticate: dict) -> bool:
+    """
+    Function Description:
+        Validate login of client to server
+
+    Function Parameters:
+        authenticate:dict
+            Login of client to server
+    """
+    if "jani-versions" in authenticate:
+        return supportedVersion in authenticate["jani-versions"]
+    else:
+        return False
+
+
+def reason(authenticate: dict) -> str:
+    """
+    Function Description:
+        Provide reason, why login failed
+
+    Function Parameters:
+        authenticate:dict
+            Login of client to server
+    """
+    if "jani-versions" in authenticate:
+        if supportedVersion not in authenticate["jani-versions"]:
+            return "Client not supporting supported JANI - Version: " + str(supportedVersion)
+    else:
+        return 'Message does not match "Authenticate"-Schema'

Protocol/protocol/interactive/roles/analyse/dataset.py

+def create(datasetID: int, experimentID: str, output: list) -> dict:
+    """
+    Function Description:
+        Create dataset structure
+
+    Function Parameters:
+        datasetID: int
+            Unique id of dataset structure in analysis task
+        experimentID: str
+            Identifier of experiment, used for creation of PINS Model
+        output: list
+            Output line by line of running LTSmin on PINS Model
+    """
+    dataset = {
+        "id": datasetID,
+        "label": "Result {}".format(datasetID),
+        "results": resultsArray(output),
+    }
+    if experimentID:
+        dataset["experiment"] = experimentID
+    return dataset
+
+
+def resultsArray(output: list) -> list:
+    """
+    Function Description:
+        Results array structure of dataset structure
+
+    Function Parameters:
+        output: list
+            Output line by line of running LTSmin on PINS Model
+    """
+    results = []
+    for line in output:
+        if line:
+            line = line.strip().split(":")
+            label = line[0]
+            information = ":".join(line[1:])
+            if label and information:
+                results.append({"label": label, "type": "string", "value": information})
+    return results

Protocol/protocol/interactive/roles/analyse/engine.py

+import protocol.basic.metadata as metadata
+import protocol.basic.modelFeatures as modelFeatures
+import protocol.basic.modellingFormalisms as modellingFormalisms
+import protocol.basic.modelTypes as modelTypes
+import protocol.interactive.roles.analyse.parameters as parameters
+
+
+def specification() -> dict:
+    """
+    Function Description:
+        Create specification of LTSmin analysis engine
+    """
+    ltsmin = {
+        "id": "ltsmin",
+        "metadata": metadata.analysisEngine(),
+        "parameters": parameters.create(),
+        "model-features": modelFeatures.supported(),
+        "model-types": modelTypes.supported(),
+        "modelling-formalisms": modellingFormalisms.supported(),
+    }
+    return ltsmin