Attempts at integration into VS (#145)

* Fixes

* Update validation_results.py

Co-authored-by: Geert Hesselink <[email protected]>

* fix import error apps.py from datamodel

* delete redundant closing bracket

---------

Co-authored-by: Geert Hesselink <[email protected]>
Co-authored-by: Ghesselink <[email protected]>

Author: aothms

features/environment.py

@@ -71,9 +71,9 @@ def get_validation_outcome_hash(obj):
 
 def after_feature(context, feature):
     execution_mode = context.config.userdata.get('execution_mode')
-    execution_mode = 'ExecutionMode.PRODUCTION'
     if execution_mode and execution_mode == 'ExecutionMode.PRODUCTION': # DB interaction only needed during production run, not in testing
         from validation_results import OutcomeSeverity, ModelInstance, ValidationTask
+
         def reduce_db_outcomes(feature_outcomes):
 
             failed_outcomes = [outcome for outcome in feature_outcomes if outcome.severity in [OutcomeSeverity.WARNING, OutcomeSeverity.ERROR]]

features/steps/givens/__init__.py

@@ -1,8 +1,6 @@
 import sys
 import os
 from pathlib import Path
-current_script_dir = os.path.dirname(os.path.abspath(__file__))
-sys.path.append(str(Path(current_script_dir).parent.parent.parent))
 from validation_results import ValidationOutcome
 
 OutcomeSeverity = ValidationOutcome.OutcomeSeverity

features/steps/steps/__init__.py

@@ -1,8 +1,6 @@
 import sys
 import os
 from pathlib import Path
-current_script_dir = os.path.dirname(os.path.abspath(__file__))
-sys.path.append(str(Path(current_script_dir).parent.parent.parent))
 from validation_results import ValidationOutcome
 
 OutcomeSeverity = ValidationOutcome.OutcomeSeverity

features/steps/thens/__init__.py

@@ -1,8 +1,6 @@
 import sys
 import os
 from pathlib import Path
-current_script_dir = os.path.dirname(os.path.abspath(__file__))
-sys.path.append(str(Path(current_script_dir).parent.parent))
 from validation_results import ValidationOutcome
 
 OutcomeSeverity = ValidationOutcome.OutcomeSeverity

features/steps/validation_handling.py

@@ -10,9 +10,6 @@
 import itertools
 from operator import attrgetter
 import ast
-current_script_dir = os.path.dirname(os.path.abspath(__file__))
-sys.path.append(str(Path(current_script_dir).parent.parent))
-
 from validation_results import ValidationOutcome, OutcomeSeverity, ValidationOutcomeCode
 
 from behave.runner import Context

main.py

@@ -62,12 +62,13 @@ def run(filename, rule_type=RuleType.ALL, with_console_output=False, execution_m
 
     # If this is a test file from the repository filter only the relevant scenarios
     feature_filter = []
-    try:
-        rule_code = os.path.basename(filename).split('-')[1].strip().upper()
-        if re.match(r'[A-Z]{3}[0-9]{3}', rule_code):
-            feature_filter = ["-i", rule_code]
-    except Exception as e:
-        print(e)
+    if execution_mode != ExecutionMode.PRODUCTION:
+        bfn = os.path.basename(filename)
+        parts = bfn.split('-')
+        if len(parts) >= 2:
+            rule_code = parts[1].strip().upper()
+            if re.match(r'[A-Z]{3}[0-9]{3}', rule_code):
+                feature_filter = ["-i", rule_code]
 
     if with_console_output:
         # Sometimes it's easier to see what happens exactly on the console output
@@ -81,6 +82,11 @@ def run(filename, rule_type=RuleType.ALL, with_console_output=False, execution_m
             ], 
         cwd=cwd
         )
+      
+    kwargs = {}
+    if execution_mode == ExecutionMode.TESTING:
+        # Only capture output in testing mode
+        kwargs['capture_output'] = True
 
     proc = subprocess.run(
         [
@@ -90,8 +96,7 @@ def run(filename, rule_type=RuleType.ALL, with_console_output=False, execution_m
             "--define", f"execution_mode={execution_mode}", 
             "-f", "json", "-o", jsonfn # save to json file
         ], 
-        cwd=cwd, capture_output=True
-    )
+        cwd=cwd, **kwargs)
 
     if execution_mode == ExecutionMode.TESTING:
         with open(jsonfn) as f:

validation_results.py

@@ -5,16 +5,33 @@
 import django
 from django.core.management import call_command
 
-current_script_dir = os.path.dirname(os.path.abspath(__file__))
-sys.path.append(str(Path(current_script_dir).parent.parent))
+# @todo importing from random directories is a security hazard, this should be properly passed as a configuration param
+current_script_dir = Path(os.path.dirname(os.path.abspath(__file__)))
+sys.path.insert(0, str(current_script_dir.parent.parent.parent.parent))
+
+try:
+    import apps.ifc_validation_models as ifc_validation_models
+except:
+    import ifc_validation_models
+
+if Path(ifc_validation_models.__file__).parent == current_script_dir / 'ifc_validation_models':
+    # we are using our own submodule
+    try:
+        ifc_validation_models.apps.IfcValidationModelsConfig.name = 'ifc_validation_models'
+    except:
+        from ifc_validation_models import apps
+        apps.IfcValidationModelsConfig.name = 'ifc_validation_models'
+    os.environ['DJANGO_SETTINGS_MODULE'] = 'ifc_validation_models.independent_worker_settings'
+else:
+    os.environ['DJANGO_SETTINGS_MODULE'] = 'apps.ifc_validation_models.dependent_worker_settings'
 
-import ifc_validation_models.apps
-
-ifc_validation_models.apps.IfcValidationModelsConfig.name = 'ifc_validation_models'
-os.environ['DJANGO_SETTINGS_MODULE'] = 'ifc_validation_models.independent_worker_settings'
 django.setup()
 
-from ifc_validation_models.models import ValidationOutcome, ModelInstance, ValidationTask
+try:
+    from apps.ifc_validation_models.models import ValidationOutcome, ModelInstance, ValidationTask
+except:
+    from ifc_validation_models.models import ValidationOutcome, ModelInstance, ValidationTask
+
 OutcomeSeverity = ValidationOutcome.OutcomeSeverity
 ValidationOutcomeCode = ValidationOutcome.ValidationOutcomeCode