Update

Signed-off-by: hoangtungdinh <11166240+hoangtungdinh@users.noreply.github.com>
asam-ev · Oct 2, 2024 · 0a068ac · 0a068ac
1 parent f03ce20
commit 0a068ac
Show file tree

Hide file tree

Showing 7 changed files with 47 additions and 15 deletions.
diff --git a/README.md b/README.md
@@ -2,6 +2,8 @@
 
 This project implements the [ASAM OpenScenario XML Checker Bundle](checker_bundle_doc.md).
 
+**Disclaimer**: The current version is a release candidate. The first official release is expected to be in November.
+
 - [asam-qc-openscenarioxml](#asam-qc-openscenarioxml)
   - [Installation and usage](#installation-and-usage)
     - [Installation using pip](#installation-using-pip)
@@ -208,3 +210,34 @@ You need to have pre-commit installed and install the hooks:
 ```
 pre-commit install
 ```
+
+**To implement a new checker**
+
+1. Create a new Python module for each checker.
+2. Specify the following global variables for the Python module
+
+| Variable | Meaning |
+| --- | --- |
+| `CHECKER_ID` | The ID of the checker |
+| `CHECKER_DESCRIPTION` | The description of the checker |
+| `CHECKER_PRECONDITIONS` | A set of other checkers in which if any of them raise an issue, the current checker will be skipped |
+| `RULE_UID` | The rule UID of the rule that the checker will check |
+
+3. Implement the checker logic in the following function:
+
+```python
+def check_rule(checker_data: models.CheckerData) -> None:
+    pass
+```
+
+1. Register the checker module in the following function in [main.py](qc_openscenario/main.py).
+
+```python
+def run_checks(config: Configuration, result: Result) -> None:
+    ...
+    # Add the following line to register your checker module
+    execute_checker(your_checker_module, checker_data)
+    ...
+```
+
+All the checkers in this checker bundle are implemented in this way. Take a look at some of them before implementing your first checker.
diff --git a/checker_bundle_doc.md b/checker_bundle_doc.md
@@ -1,12 +1,12 @@
-
 # Checker bundle: xoscBundle
 
-* Build version:  0.1.0
+* Build version:  v1.0.0-rc.1
 * Description:    OpenScenario checker bundle
 
 ## Parameters
 
 * InputFile
+* resultFile
 
 ## Checkers
 

diff --git a/manifest_templates/windows_xosc_manifest.json b/manifest_templates/windows_xosc_manifest.json
@@ -4,7 +4,7 @@
       "name": "xoscBundle",
       "exec_type": "executable",
       "module_type": "checker_bundle",
-      "exec_command": "cd %ASAM_QC_FRAMEWORK_WORKING_DIR% && qc_openscenario -c %ASAM_QC_FRAMEWORK_CONFIG_FILE%"
+      "exec_command": "cd \"%ASAM_QC_FRAMEWORK_WORKING_DIR%\" && qc_openscenario -c \"%ASAM_QC_FRAMEWORK_CONFIG_FILE%\""
     }
   ]
 }
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "asam-qc-openscenarioxml"
-version = "0.1.0"
+version = "1.0.0rc1"
 description = "This project implements the OpenScenario Checker for the ASAM Quality Checker project."
 authors = ["Danilo Romano <danilo@ivex.ai>"]
 license = "MPL-2.0"

diff --git a/qc_openscenario/constants.py b/qc_openscenario/constants.py
@@ -1,2 +1,2 @@
 BUNDLE_NAME = "xoscBundle"
-BUNDLE_VERSION = "0.1.0"
+BUNDLE_VERSION = "v1.0.0-rc.1"
diff --git a/qc_openscenario/main.py b/qc_openscenario/main.py
@@ -234,7 +234,6 @@ def main():
         result = Result()
         result.register_checker_bundle(
             name=constants.BUNDLE_NAME,
-            build_date=datetime.today().strftime("%Y-%m-%d"),
             description="OpenScenario checker bundle",
             version=constants.BUNDLE_VERSION,
             summary="",