Write system tests and requirements for lobster-json

- Add a requirement to specify the behavior when the tool is given an input file.
- Introduced `System_Requirement_Aspect` to RSL file

.gitignore

@@ -15,3 +15,4 @@ test_install_monolithic
 .coverage*
 *.lobster
 *.html
+.idea

lobster/tools/json/input_files.trlc

@@ -0,0 +1,47 @@
+package json_req
+import req
+
+req.System_Requirement Parse_Input_File {
+    description = '''
+      IF a list element given through the command line option "FILE_OR_DIR" is not a file nor a directory,
+      THEN the tool shall exit with a non-zero return code.
+    '''
+}
+
+req.System_Requirement_Aspect Parse_Input_File_JSON_Extension {
+  description = '''
+    OTHERWISE,
+    if the file extension is not "json" (case-insensitive),
+    THEN the tool shall print a warning.
+    Note - The file still will be parsed.
+  '''
+}
+
+req.System_Requirement_Aspect Parse_Input_File_Valid_JSON {
+  description = '''
+    OTHERWISE,
+    if the file content is invalid JSON,
+    THEN the tool shall exit with a non-zero return code.
+  '''
+}
+
+req.System_Requirement_Aspect Parse_Input_File_Input_Items {
+  description = '''
+    OTHERWISE the input data
+    SHALL be written in the LOBSTER interchange format
+  '''
+  // TODO: This requirement needs more details.
+}
+
+req.System_Requirement_Aspect Parse_Input_File_To_Stdout {
+  description = '''
+    to the file given in the command line option "out",
+    IF that option is given and is not an empty string,
+  '''
+}
+
+req.System_Requirement_Aspect Parse_Input_File_To_File {
+  description = '''
+    OTHERWISE to STDOUT.
+  '''
+}

lobster/tools/json/synthetic_name.trlc

@@ -0,0 +1,25 @@
+package json_req
+import req
+
+req.System_Requirement Name_Attribute_Given {
+  description = '''
+    In addition to [[Parse_Input_File]],
+    IF the command line option "name-attribute" is given and not an empty string,
+    THEN the tool
+    SHALL obtain the value from the input item at that key,
+    and use the obtained value as tag in the serialized LOBSTER item.
+    '''
+}
+
+req.System_Requirement_Aspect Name_Attribute_Missing {
+  description = '''
+    OTHERWISE, the tool
+    SHALL create a synthetic tag name based on the path of the JSON input file and an item counter.
+
+    Notes:
+    - "Synthetic" means that, the name does not need to be related to the data.
+    - The item counter does not need to be unique across input files,
+      but it shall be unique at least for each input file separately.
+    - No further specification is made about how to combine the path and the item counter.
+  '''
+}

lobster/tools/lobster-trlc.conf

@@ -1,3 +1,7 @@
 req.System_Requirement {
   description = description
 }
+
+req.System_Requirement_Aspect {
+  description = description
+}

lobster/tools/requirements.rsl

@@ -8,6 +8,19 @@ type System_Requirement {
   ''' String
 }
 
+type System_Requirement_Aspect extends System_Requirement {
+  /* This type describes an aspect of a system requirement.
+     The aspect itself is not testable. It is only testable in the context of a requirement.
+     For example, an aspect may give details about a certain input, but it does not describe
+     the related output.
+     Nevertheless, system tests shall be linked to aspects, and each aspect shall be covered
+     by system tests. These tests must always take the requirement into account, which uses
+     the aspect.
+     Using this type helps to make long requirements easier to read, and it is easier to
+     develop tests for them.
+   */
+}
+
 type Software_Requirement {
   description '''
     The content of the requirement.

tests-system/.gitignore

@@ -1,2 +1 @@
-!**/expected-output/*
-!**/input/*
+!**/expected-output/*

tests-system/lobster-json/rbt-parse-input-file-input-items/outer-and-inner/README.md

@@ -0,0 +1,3 @@
+The input file of this test defines a JSON data struct which has got data items in its
+outer-most dictionary, as well as nested items.
+According to the requirement only the data items from the outer-most dictionary must be considered.

tests-system/lobster-json/rbt-parse-input-file-input-items/outer-and-inner/expected-output/exit-code.txt

@@ -0,0 +1 @@
+0

tests-system/lobster-json/rbt-parse-input-file-input-items/outer-and-inner/expected-output/stdout.txt

@@ -0,0 +1 @@
+lobster-json: wrote 1 items to output.lobster

tests-system/lobster-json/rbt-parse-input-file-input-items/outer-and-inner/input/args.txt

@@ -0,0 +1,3 @@
+--single
+--tag-attribute=something
+--out=output.lobster

tests-system/lobster-json/rbt-parse-input-file-input-items/outer-and-inner/input/data.json

@@ -0,0 +1,25 @@
+{
+    "outer1": {
+      "data": [
+        {
+          "name": "Take this item!"
+        },
+        {
+
+            "name": "unclear"
+        }
+      ]
+    },
+    "outer2": {
+        "data": [
+          {
+            "name": "Take this item!"
+          },
+          {
+
+              "name": "unclear"
+          }
+        ]
+      }
+  }
+

tests-system/lobster-json/rbt-parse-input-file-input-items/outer-and-inner/tracing.txt

@@ -0,0 +1,3 @@
+# This test verifies these requirements:
+Parse_Input_File
+Parse_Input_File_JSON_Extension

tests-system/lobster-json/rbt-parse-input-file-json-extension/invalid-json-file-extension/README.md

@@ -0,0 +1,2 @@
+The goal of this test is to check if a warning message is printed when the input 
+file has a non json extension.

tests-system/lobster-json/rbt-parse-input-file-json-extension/invalid-json-file-extension/expected-output/exit-code.txt

@@ -0,0 +1 @@
+0

tests-system/lobster-json/rbt-parse-input-file-json-extension/invalid-json-file-extension/expected-output/output.lobster

@@ -0,0 +1,24 @@
+{
+  "data": [
+    {
+      "tag": "json data.invalidjson:data.invalidjson.1",
+      "location": {
+        "kind": "file",
+        "file": "data.invalidjson",
+        "line": null,
+        "column": null
+      },
+      "name": "data.invalidjson:data.invalidjson.1",
+      "messages": [],
+      "just_up": [],
+      "just_down": [],
+      "just_global": [],
+      "framework": "JSON",
+      "kind": "Test Vector",
+      "status": null
+    }
+  ],
+  "generator": "lobster-json",
+  "schema": "lobster-act-trace",
+  "version": 3
+}

tests-system/lobster-json/rbt-parse-input-file-json-extension/invalid-json-file-extension/expected-output/stdout.txt

@@ -0,0 +1,2 @@
+<cmdline>: lobster warning: not a .json file
+lobster-json: wrote 1 items to output.lobster

tests-system/lobster-json/rbt-parse-input-file-json-extension/invalid-json-file-extension/input/args.txt

@@ -0,0 +1,4 @@
+--single
+--tag-attribute=something
+--out=output.lobster
+data.invalidjson

tests-system/lobster-json/rbt-parse-input-file-json-extension/invalid-json-file-extension/input/data.invalidjson

@@ -0,0 +1,10 @@
+{
+  "items": {
+    "data": [
+      {
+        "name": "Take this item!"
+      }
+    ]
+  }
+}
+

tests-system/lobster-json/rbt-parse-input-file-json-extension/mixed-extensions/README.md

@@ -0,0 +1,2 @@
+The goal of this test is to check if a warning message is printed when the input 
+file has a non json extension.

tests-system/lobster-json/rbt-parse-input-file-json-extension/mixed-extensions/expected-output/exit-code.txt

@@ -0,0 +1 @@
+0

tests-system/lobster-json/rbt-parse-input-file-json-extension/mixed-extensions/expected-output/output.lobster

@@ -0,0 +1,41 @@
+{
+  "data": [
+    {
+      "tag": "json data.invalidjson:data.invalidjson.1",
+      "location": {
+        "kind": "file",
+        "file": "data.invalidjson",
+        "line": null,
+        "column": null
+      },
+      "name": "data.invalidjson:data.invalidjson.1",
+      "messages": [],
+      "just_up": [],
+      "just_down": [],
+      "just_global": [],
+      "framework": "JSON",
+      "kind": "Test Vector",
+      "status": null
+    },
+    {
+      "tag": "json valid.json:valid.1",
+      "location": {
+        "kind": "file",
+        "file": "valid.json",
+        "line": null,
+        "column": null
+      },
+      "name": "valid.json:valid.1",
+      "messages": [],
+      "just_up": [],
+      "just_down": [],
+      "just_global": [],
+      "framework": "JSON",
+      "kind": "Test Vector",
+      "status": null
+    }
+  ],
+  "generator": "lobster-json",
+  "schema": "lobster-act-trace",
+  "version": 3
+}

tests-system/lobster-json/rbt-parse-input-file-json-extension/mixed-extensions/expected-output/stdout.txt

@@ -0,0 +1,2 @@
+<cmdline>: lobster warning: not a .json file
+lobster-json: wrote 2 items to output.lobster

tests-system/lobster-json/rbt-parse-input-file-json-extension/mixed-extensions/input/args.txt

@@ -0,0 +1,5 @@
+--single
+--tag-attribute=something
+--out=output.lobster
+data.invalidjson
+valid.json

tests-system/lobster-json/rbt-parse-input-file-json-extension/mixed-extensions/input/data.invalidjson

@@ -0,0 +1,13 @@
+{
+  "items": {
+    "data": [
+      {
+        "name": "Take this item!"
+      },
+      {
+        "name": "unclear"
+      }
+    ]
+  }
+}
+

tests-system/lobster-json/rbt-parse-input-file-json-extension/mixed-extensions/input/valid.json

@@ -0,0 +1,10 @@
+{
+  "items": {
+    "data": [
+      {
+        "name": "This file has a valid json extension"
+      }
+    ]
+  }
+}
+

tests-system/lobster-json/rbt-parse-input-file/file-does-not-exist/README.md

@@ -0,0 +1,2 @@
+The goal of this test is to check if an error message gets printed
+if the input file to the lobster-json tool does not exist

tests-system/lobster-json/rbt-parse-input-file/file-does-not-exist/expected-output/exit-code.txt

@@ -0,0 +1 @@
+1

tests-system/lobster-json/rbt-parse-input-file/file-does-not-exist/expected-output/stdout.txt

@@ -0,0 +1 @@
+<cmdline>: lobster error: file/does/not_exists.json is not a file or directory

tests-system/lobster-json/rbt-parse-input-file/file-does-not-exist/input/args.txt

@@ -0,0 +1,4 @@
+--single
+--tag-attribute=something
+--out=output.lobster
+file/does/not_exists.json