Merge pull request #330 from NREL/too-many-options

adding validation of the number of options in the ApplyUpgrade measure

.github/workflows/ci.yml

@@ -79,4 +79,4 @@ jobs:
         if: ${{ matrix.python-version == '3.10' }}
         with:
           name: documentation
-          path: docs/_build/html/
+          path: buildstockbatch/docs/_build/html/

buildstockbatch/base.py

@@ -14,8 +14,10 @@
 import difflib
 from fsspec.implementations.local import LocalFileSystem
 import logging
+from lxml import objectify
 import os
 import pandas as pd
+import re
 import requests
 import shutil
 import tempfile
@@ -261,6 +263,7 @@ def validate_project(project_file):
         assert BuildStockBatchBase.validate_postprocessing_spec(project_file)
         assert BuildStockBatchBase.validate_resstock_or_comstock_version(project_file)
         assert BuildStockBatchBase.validate_openstudio_version(project_file)
+        assert BuildStockBatchBase.validate_number_of_options(project_file)
         logger.info('Base Validation Successful')
         return True
 
@@ -702,6 +705,61 @@ def validate_resstock_or_comstock_version(project_file):
 
         return True
 
+    @staticmethod
+    def validate_number_of_options(project_file):
+        """Checks that there aren't more options than are allowed in the ApplyUpgrade measure.
+
+        :param project_file: path to project file
+        :type project_file: str
+        :raises ValidationError: if there are more options defined than there are in the measure.
+        :return: whether validation passes or not
+        :rtype: bool
+        """
+        cfg = get_project_configuration(project_file)
+        measure_xml_filename = os.path.join(
+            cfg["buildstock_directory"], "measures", "ApplyUpgrade", "measure.xml"
+        )
+        if os.path.exists(measure_xml_filename):
+            measure_xml_tree = objectify.parse(measure_xml_filename)
+            measure_xml = measure_xml_tree.getroot()
+            n_options_in_measure = 0
+            n_costs_per_option_in_measure = 0
+            for argument in measure_xml.arguments.argument:
+                m_option = re.match(r"^option_(\d+)$", str(argument.name))
+                if m_option:
+                    option_number = int(m_option.group(1))
+                    n_options_in_measure = max(option_number, n_options_in_measure)
+                m_costs = re.match(r"^option_(\d+)_cost_(\d+)_value", str(argument.name))
+                if m_costs:
+                    cost_number = int(m_costs.group(2))
+                    n_costs_per_option_in_measure = max(cost_number, n_costs_per_option_in_measure)
+            n_options_in_cfg = 0
+            n_costs_in_cfg = 0
+            for upgrade in cfg.get("upgrades", []):
+                options = upgrade.get("options", [])
+                n_options = len(options)
+                n_costs = max(len(option.get("costs", [])) for option in options)
+                n_options_in_cfg = max(n_options, n_options_in_cfg)
+                n_costs_in_cfg = max(n_costs, n_costs_in_cfg)
+            err_msgs = []
+            if n_options_in_cfg > n_options_in_measure:
+                err_msgs.append(
+                    f"There are {n_options_in_cfg} options in an upgrade in your project file and only "
+                    f"{n_options_in_measure} in the ApplyUpgrade measure."
+                )
+            if n_costs_in_cfg > n_costs_per_option_in_measure:
+                err_msgs.append(
+                    f"There are {n_costs_in_cfg} costs on an option in your project file and only "
+                    f"{n_costs_per_option_in_measure} in the ApplyUpgrade measure."
+                )
+            if err_msgs:
+                err_msgs.append(
+                    "See https://github.com/NREL/buildstockbatch/wiki/Adding-Options-to-the-ApplyUpgrade-measure"
+                )
+                raise ValidationError("\n".join(err_msgs))
+
+        return True
+
     @staticmethod
     def validate_openstudio_version(project_file):
         """

buildstockbatch/localdocker.py

@@ -13,6 +13,7 @@
 import argparse
 from dask.distributed import Client, LocalCluster
 import docker
+from docker.errors import ImageNotFound
 import functools
 from fsspec.implementations.local import LocalFileSystem
 import gzip
@@ -66,8 +67,11 @@ class LocalDockerBatch(DockerBatchBase):
 
     def __init__(self, project_filename):
         super().__init__(project_filename)
-        logger.debug(f'Pulling docker image: {self.docker_image}')
-        self.docker_client.images.pull(self.docker_image)
+        try:
+            self.docker_client.images.get(self.docker_image)
+        except ImageNotFound:
+            logger.debug(f'Pulling docker image: {self.docker_image}')
+            self.docker_client.images.pull(self.docker_image)
 
         # Create simulation_output dir
         sim_out_ts_dir = os.path.join(self.results_dir, 'simulation_output', 'timeseries')

buildstockbatch/test/test_integration.py

@@ -3,8 +3,12 @@
 import pathlib
 import pytest
 import shutil
+import tempfile
+import json
 
 from buildstockbatch.localdocker import LocalDockerBatch
+from buildstockbatch.utils import get_project_configuration
+from buildstockbatch.exc import ValidationError
 
 resstock_directory = pathlib.Path(
     os.environ.get("RESSTOCK_DIR", pathlib.Path(__file__).resolve().parent.parent.parent.parent / "resstock")
@@ -22,7 +26,7 @@
     resstock_directory / "project_testing" / "testing_upgrades.yml",
 ], ids=lambda x: x.stem)
 @resstock_required
-def test_resstock_local_batch(project_filename, mocker):
+def test_resstock_local_batch(project_filename):
     LocalDockerBatch.validate_project(str(project_filename))
     batch = LocalDockerBatch(str(project_filename))
 
@@ -81,3 +85,18 @@ def test_resstock_local_batch(project_filename, mocker):
     assert (ts_pq_path / "_metadata").exists()
 
     shutil.rmtree(out_path)
+
+
+@resstock_required
+def test_number_of_options_apply_upgrade():
+    proj_filename = resstock_directory / "project_national" / "national_upgrades.yml"
+    cfg = get_project_configuration(str(proj_filename))
+    cfg["upgrades"][-1]["options"] = cfg["upgrades"][-1]["options"] * 10
+    cfg["upgrades"][0]["options"][0]["costs"] = cfg["upgrades"][0]["options"][0]["costs"] * 5
+    with tempfile.TemporaryDirectory() as tmpdir:
+        tmppath = pathlib.Path(tmpdir)
+        new_proj_filename = tmppath / "project.yml"
+        with open(new_proj_filename, "w") as f:
+            json.dump(cfg, f)
+        with pytest.raises(ValidationError):
+            LocalDockerBatch.validate_number_of_options(str(new_proj_filename))

docs/changelog/changelog_dev.rst

@@ -25,4 +25,14 @@ Development Changelog
         :tags: general
         :pullreq: 326
 
-        Adds some integration tests with the lastest ResStock.
+        Adds some integration tests with the latest ResStock.
+
+    .. change::
+        :tags: validation
+        :pullreq: 330
+        :tickets: 329
+
+        Adds a validation step to verify the ApplyUpgrade measure has enough
+        options specified to support the upgrades in the current project file.
+        Instructs the user how to add more options to the ApplyUpgrade measure
+        if not.

setup.py

@@ -68,6 +68,7 @@ def run_tests(self):
         'yamale',
         'ruamel.yaml',
         'awsretry',
+        'lxml'
     ],
     extras_require={
         'dev': [