merged with dev

.coveragerc

@@ -0,0 +1,10 @@
+[run]
+branch = True
+
+# there is some weird error 'no source for code .../config-3.py' the file doesnt exist.
+# It might be related to opencv? or gyms entry point mechanism...
+
+[report]
+ignore_errors = True
+include =
+    worldofbugs/worldofbugs/*

.gitignore

@@ -1,7 +1,9 @@
+logs/
+.vscode
+
 # Builds (use build.cs to build the scenes)
 builds/
 dataset/
-test/ 
 tmp/
 
 *.tar.hz
@@ -152,4 +154,4 @@ dmypy.json
 .pytype/
 
 # Cython debug symbols
-cython_debug/
+cython_debug/

.gitmodules

@@ -0,0 +1,6 @@
+[submodule "com.worldofbugs.worldofbugs/External/NavMeshComponents"]
+	path = com.worldofbugs.worldofbugs/External/NavMeshComponents
+	url = https://github.com/Unity-Technologies/NavMeshComponents.git
+[submodule "com.worldofbugs.worldofbugs/External/ClassTypeReference-for-Unity"]
+	path = com.worldofbugs.worldofbugs/External/ClassTypeReference-for-Unity
+	url = https://github.com/SolidAlloy/ClassTypeReference-for-Unity.git

.isort.cfg

@@ -0,0 +1,4 @@
+[settings]
+multi_line_output=3
+include_trailing_comma=True
+line_length=88

.pre-commit-config.yaml

@@ -0,0 +1,62 @@
+exclude : '.*(\.(asset|meta|mat|unity|prefab))'
+
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.3.0
+    hooks:
+    -   id: check-yaml
+    -   id: end-of-file-fixer
+        files : .*(\.py|\.cs)
+        #exclude : '(isort\.cfg|*.(\.svg))' # some weird conflict that is never resolved...
+    -   id: trailing-whitespace
+
+# python tests / linting etc
+- repo: https://github.com/pycqa/isort
+  rev: 5.10.1
+  hooks:
+    - id: isort
+      name: isort (python)
+
+-   repo: https://github.com/psf/black
+    rev: 22.3.0
+    hooks:
+    -   id: black
+        name: black
+        language_version: python3.8
+        types: [python]
+        stages: [commit]
+
+- repo: local
+  hooks:
+    - id: lint # python linting
+      name: lint
+      entry: python worldofbugs/worldofbugs/test/lint.py
+      language: system
+      pass_filenames: false
+      log_file: logs/lint.log
+
+
+    # TODO it would be nice to have a report here...
+    - id : unit-test
+      name : unit-test
+      entry : coverage run -m unittest discover -s worldofbugs/worldofbugs/test/unit -v
+      language: system
+      pass_filenames: false
+      log_file : logs/unit-test.log
+
+
+    # c-sharp code formatting
+    - id: astyle
+      name: astyle
+      entry: bash worldofbugs/worldofbugs/test/scripts/astyle.sh
+      language: system
+      pass_filenames: false
+      log_file: logs/astyle.log
+
+    # run
+    - id : unity-runtime-test
+      name : unity-runtime-test
+      entry : python worldofbugs/worldofbugs/test/unity-test.py
+      language : system
+      pass_filenames : false
+      log_file: logs/unity-test.log

.pylintrc

@@ -0,0 +1,6 @@
+[MASTER]
+disable=
+    C0301, # missing-module-docstring
+    C0415, # import-outside-toplevel
+    R0903, # too-few-public-methods
+good-names-rgxs=^[_a-z][_a-z0-9]?$

.vscode/settings.json

@@ -1,3 +1,12 @@
 {
-    "python.linting.enabled": true
-}
+    "python.linting.enabled": true,
+    "ltex.language": "en-GB",
+    "ltex.dictionary": {
+        "en-GB": [
+            "WOB",
+            "ML-Agents",
+            "recognised",
+            "completionist",
+        ]
+    }
+}

README.md

@@ -1,6 +1,12 @@
+
+[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://pre-commit.com/)
+[![Pylint](docs/_badge/pylint.svg)](https://github.com/PyCQA/pylint)
+[![Code style: astyle](docs/_badge/astyle.svg)](http://astyle.sourceforge.net)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+
 # WorldOfBugs
 
-World of Bugs is a test plaform for Automated Bug Detection (ABD) research. 
+World of Bugs is a test platform for Automated Bug Detection (ABD) research.
 
 ## READER NOTE:
 
@@ -21,21 +27,6 @@ Datasets have been created using our test environment (World-v1), a pre-built ve
 
 Experiments on the initial version of the test environment (World-v1) can be found in [this](https://github.com/BenedictWilkins/world-of-bugs-experiments) repository.
 
-
-
 ### Paper
 
-[Learning to Identify Perceptual Bugs in 3D Video Games](https://arxiv.org/abs/2202.12884) 
-Submitted to [COG 2022](https://ieee-cog.org/2022/) awaiting peer-review.
-
-Citation:
-```
-@article{Wilkins2022,
-	title = {Learning to Identify Perceptual Bugs in 3D Video Games},
-	url = {http://arxiv.org/abs/2202.12884},
-	journaltitle = {{arXiv}:2202.12884 [cs]},
-	author = {Wilkins, Benedict and Stathis, Kostas},
-}
-```
-
-
+LINKS COMING SOON

TODO.md

@@ -0,0 +1,5 @@
+* add tests to com.worldofbugs.worldofbugs, there should be a specific means to test new kinds of bugs?
+* test all sample environments and build them
+* create c# code reference documentation
+* create first release
+* add to Unity open package registry