class TestLandCoverService(TestWithFullModelRun):
def setUp(self):
dap_client_factory = DapClientFactory()
dap_client_factory.get_land_cover_dap_client = self._mock_get_land_cover_dap_client
dap_client_factory.get_soil_properties_dap_client = self._mock_get_soil_properties_dap_client
self.land_cover_service = LandCoverService(dap_client_factory=dap_client_factory)
self.model_run_service = ModelRunService()
self.dataset_service = DatasetService()
self.parameter_service = ParameterService()
self.clean_database()
self.user = self.login()
self.create_model_run_ready_for_submit()
@staticmethod
def _mock_get_land_cover_dap_client(url, key):
return MockLandCoverDapClient(url, key)
@staticmethod
def _mock_get_soil_properties_dap_client(url):
return MockSoilPropertiesDapClient(url)
def test_GIVEN_land_cover_regions_exist_WHEN_get_land_cover_region_by_id_THEN_land_cover_region_returned(self):
model_run = self.model_run_service.get_model_being_created_with_non_default_parameter_values(self.user)
land_cover_region = self.add_land_cover_region(model_run)
id = land_cover_region.id
returned_region = self.land_cover_service.get_land_cover_region_by_id(id)
assert_that(returned_region.id, is_(id))
assert_that(returned_region.name, is_("Wales"))
def test_GIVEN_land_cover_categories_WHEN_get_land_cover_region_THEN_returned_region_has_category_loaded(self):
model_run = self.model_run_service.get_model_being_created_with_non_default_parameter_values(self.user)
land_cover_region = self.add_land_cover_region(model_run)
id = land_cover_region.id
with session_scope() as session:
land_cover_cat = LandCoverRegionCategory()
land_cover_cat.name = "River Catchments"
land_cover_cat.driving_dataset_id = model_run.driving_dataset_id
session.add(land_cover_cat)
returned_region = self.land_cover_service.get_land_cover_region_by_id(id)
assert_that(returned_region.category.name, is_("Countries"))
def test_GIVEN_land_cover_values_WHEN_get_land_cover_values_THEN_land_cover_values_returned(self):
lc_values = self.land_cover_service.get_land_cover_values(None)
assert_that(len(lc_values), is_(9))
names = [lc_value.name for lc_value in lc_values]
assert 'Urban' in names
assert constants.FRACTIONAL_ICE_NAME in names
def test_GIVEN_return_no_ice_WHEN_get_land_cover_values_THEN_land_cover_values_returned(self):
lc_values = self.land_cover_service.get_land_cover_values(None, return_ice=False)
assert_that(len(lc_values), is_(8))
names = [lc_value.name for lc_value in lc_values]
assert 'Urban' in names
assert constants.FRACTIONAL_ICE_NAME not in names
def test_GIVEN_multiple_land_cover_categories_WHEN_get_categories_THEN_correct_categories_returned(self):
model_run = self.model_run_service.get_model_being_created_with_non_default_parameter_values(self.user)
datasets = self.dataset_service.get_driving_datasets(self.user)
with session_scope() as session:
cat1 = LandCoverRegionCategory()
cat1.name = "Countries"
cat1.driving_dataset_id = model_run.driving_dataset_id
region1 = LandCoverRegion()
region1.mask_file = "filepath"
region1.name = "Wales"
region1.category = cat1
cat2 = LandCoverRegionCategory()
cat2.name = "Rivers"
cat2.driving_dataset_id = datasets[1].id
region2 = LandCoverRegion()
region2.mask_file = "filepath2"
region2.name = "Thames"
region2.category = cat2
session.add_all([region1, region2])
categories = self.land_cover_service.get_land_cover_categories(model_run.driving_dataset_id)
assert_that(len(categories), is_(1))
assert_that(categories[0].name, is_("Countries"))
def test_GIVEN_categories_have_land_cover_regions_WHEN_get_categories_THEN_category_has_regions_loaded(self):
model_run = self.model_run_service.get_model_being_created_with_non_default_parameter_values(self.user)
with session_scope() as session:
cat1 = LandCoverRegionCategory()
cat1.name = "Countries"
cat1.driving_dataset_id = model_run.driving_dataset_id
region1 = LandCoverRegion()
region1.mask_file = "filepath"
region1.name = "Wales"
region1.category = cat1
cat2 = LandCoverRegionCategory()
cat2.name = "Rivers"
cat2.driving_dataset_id = model_run.driving_dataset_id
region2 = LandCoverRegion()
region2.mask_file = "filepath2"
region2.name = "Thames"
region2.category = cat2
session.add_all([region1, region2])
categories = self.land_cover_service.get_land_cover_categories(model_run.driving_dataset_id)
assert_that(len(categories[0].regions), is_(1))
assert_that(categories[0].regions[0].name, is_("Wales"))
def test_GIVEN_land_cover_actions_WHEN_save_land_cover_actions_THEN_land_cover_actions_saved(self):
model_run = self.model_run_service.get_model_being_created_with_non_default_parameter_values(self.user)
land_cover_region = self.add_land_cover_region(model_run)
self.add_land_cover_actions(land_cover_region, model_run, [(1, 1), (2, 3)], self.land_cover_service)
with session_scope() as session:
model_run = self.model_run_service._get_model_run_being_created(session, self.user)
actions = model_run.land_cover_actions
assert_that(len(actions), is_(2))
def test_GIVEN_existing_land_cover_actions_WHEN_save_land_cover_actions_THEN_land_cover_actions_overwritten(self):
model_run = self.model_run_service.get_model_being_created_with_non_default_parameter_values(self.user)
land_cover_region = self.add_land_cover_region(model_run)
self.add_land_cover_actions(land_cover_region, model_run, [(1, 1), (2, 3)], self.land_cover_service)
self.add_land_cover_actions(land_cover_region, model_run, [(2, 4)], self.land_cover_service)
with session_scope() as session:
model_run = self.model_run_service._get_model_run_being_created(session, self.user)
actions = model_run.land_cover_actions
assert_that(len(actions), is_(1))
assert_that(actions[0].value_id, is_(2))
assert_that(actions[0].order, is_(4))
def test_GIVEN_no_land_cover_actions_WHEN_save_land_cover_actions_THEN_all_land_cover_actions_removed(self):
model_run = self.model_run_service.get_model_being_created_with_non_default_parameter_values(self.user)
land_cover_region = self.add_land_cover_region(model_run)
self.add_land_cover_actions(land_cover_region, model_run, [(1, 1), (2, 3)], self.land_cover_service)
self.add_land_cover_actions(land_cover_region, model_run, [], self.land_cover_service)
with session_scope() as session:
model_run = self.model_run_service._get_model_run_being_created(session, self.user)
actions = model_run.land_cover_actions
assert_that(len(actions), is_(0))
def test_GIVEN_land_cover_actions_saved_on_model_run_WHEN_get_land_cover_actions_THEN_actions_returned(self):
model_run = self.model_run_service.get_model_being_created_with_non_default_parameter_values(self.user)
land_cover_region = self.add_land_cover_region(model_run)
self.add_land_cover_actions(land_cover_region, model_run, [(1, 1), (2, 3)], self.land_cover_service)
actions = self.land_cover_service.get_land_cover_actions_for_model(model_run)
assert_that(len(actions), is_(2))
assert_that(actions[0].value_id, is_(1))
assert_that(actions[0].order, is_(1))
assert_that(actions[1].value_id, is_(2))
assert_that(actions[1].order, is_(3))
def test_GIVEN_land_cover_actions_saved_WHEN_get_actions_THEN_actions_have_regions_and_categories_loaded(self):
model_run = self.model_run_service.get_model_being_created_with_non_default_parameter_values(self.user)
land_cover_region = self.add_land_cover_region(model_run)
self.add_land_cover_actions(land_cover_region, model_run, [(1, 1)], self.land_cover_service)
action = self.land_cover_service.get_land_cover_actions_for_model(model_run)[0]
assert_that(action.region.name, is_("Wales"))
assert_that(action.region.category.name, is_("Countries"))
def test_GIVEN_land_cover_actions_saved_WHEN_get_actions_THEN_actions_have_values_loaded(self):
model_run = self.model_run_service.get_model_being_created_with_non_default_parameter_values(self.user)
land_cover_region = self.add_land_cover_region(model_run)
self.add_land_cover_actions(land_cover_region, model_run, [(1, 1)], self.land_cover_service)
action = self.land_cover_service.get_land_cover_actions_for_model(model_run)[0]
assert_that(action.value.name, is_("Broad-leaved Tree"))
def test_GIVEN_fractional_string_WHEN_save_fractional_land_cover_for_model_THEN_fractional_cover_saved(self):
model_run = self.model_run_service.get_model_being_created_with_non_default_parameter_values(self.user)
assert_that(model_run.land_cover_frac, is_(None))
fractional_string = "0\t0\t0\t0\t0\t0\t0\t0\t1"
self.land_cover_service.save_fractional_land_cover_for_model(model_run, fractional_string)
model_run = self.model_run_service.get_model_being_created_with_non_default_parameter_values(self.user)
assert_that(model_run.land_cover_frac, is_(fractional_string))
def test_GIVEN_user_uploaded_driving_data_WHEN_get_default_fractional_cover_THEN_fractional_cover_returned(self):
self.clean_database()
self.user = self.login()
self.create_model_run_with_user_uploaded_driving_data()
model_run = self.set_model_run_latlon(self.user, 70, 0)
fractional_vals = self.land_cover_service.get_default_fractional_cover(model_run, self.user)
assert_that(fractional_vals, is_([0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 1.0]))
def test_GIVEN_two_matching_datasets_WHEN_get_default_cover_THEN_higher_priority_fractional_cover_returned(self):
self.clean_database()
self.user = self.login()
self.create_model_run_with_user_uploaded_driving_data()
model_run = self.set_model_run_latlon(self.user, 0, 0)
fractional_vals = self.land_cover_service.get_default_fractional_cover(model_run, self.user)
assert_that(fractional_vals, is_([0.02, 0.11, 0.02, 0.05, 0.35, 0.19, 0.22, 0.04, 0.0]))
def test_GIVEN_no_matching_datasets_WHEN_get_default_cover_THEN_zeros_returned(self):
self.clean_database()
self.user = self.login()
self.create_model_run_with_user_uploaded_driving_data()
model_run = self.set_model_run_latlon(self.user, 88, 0)
fractional_vals = self.land_cover_service.get_default_fractional_cover(model_run, self.user)
assert_that(fractional_vals, is_([0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]))
def test_GIVEN_thredds_not_working_WHEN_get_default_cover_THEN_zeros_returned(self):
self.clean_database()
self.user = self.login()
self.create_model_run_with_user_uploaded_driving_data()
def _get_broken_dap_client(url, key):
return MockLandCoverDapClient("broken_url", key)
dap_client_factory = DapClientFactory()
dap_client_factory.get_land_cover_dap_client = _get_broken_dap_client
self.land_cover_service = LandCoverService(dap_client_factory=dap_client_factory)
model_run = self.model_run_service.get_model_being_created_with_non_default_parameter_values(self.user)
fractional_vals = self.land_cover_service.get_default_fractional_cover(model_run, self.user)
assert_that(fractional_vals, is_([0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]))
def test_GIVEN_using_provided_driving_data_WHEN_get_default_fractional_cover_THEN_fractional_cover_returned(self):
self.clean_database()
self.user = self.login()
self.create_alternate_model_run()
model_run = self.model_run_service.get_model_being_created_with_non_default_parameter_values(self.user)
fractional_vals = self.land_cover_service.get_default_fractional_cover(model_run, self.user)
assert_that(fractional_vals, is_([0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 1.0, 0.0]))
def test_GIVEN_multicell_model_run_WHEN_get_default_fractional_cover_THEN_ServiceException_raised(self):
self.clean_database()
self.user = self.login()
self.create_model_run_ready_for_submit()
model_run = self.model_run_service.get_model_being_created_with_non_default_parameter_values(self.user)
with self.assertRaises(ServiceException):
self.land_cover_service.get_default_fractional_cover(model_run, self.user)
def test_GIVEN_user_uploaded_driving_data_WHEN_set_default_soil_properties_THEN_soil_cover_set(self):
self.clean_database()
self.user = self.login()
self.create_model_run_with_user_uploaded_driving_data()
model_run = self.set_model_run_latlon(self.user, 51, 0)
self.land_cover_service.save_default_soil_properties(model_run, self.user)
#self._land_cover_service.dap_client_factory.get_soil_properties_dap_client = _mock_get_soil_props_client
model_run = self.model_run_service.get_model_being_created_with_non_default_parameter_values(self.user)
nvars = model_run.get_python_parameter_value(constants.JULES_PARAM_SOIL_PROPS_NVARS)
var = model_run.get_python_parameter_value(constants.JULES_PARAM_SOIL_PROPS_VAR, is_list=True)
use_file = model_run.get_python_parameter_value(constants.JULES_PARAM_SOIL_PROPS_USE_FILE, is_list=True)
const_val = model_run.get_python_parameter_value(constants.JULES_PARAM_SOIL_PROPS_CONST_VAL, is_list=True)
assert_that(nvars, is_(9))
assert_that(var, is_(['b', 'sathh', 'satcon', 'sm_sat', 'sm_crit', 'sm_wilt', 'hcap', 'hcon', 'albsoil']))
assert_that(use_file, is_(9 * [False]))
assert_that(const_val, is_([0.9, 0.0, 0.0, 50.0, 275.0, 278.0, 10.0, 0.0, 0.5]))
def test_GIVEN_no_appropriate_driving_data_WHEN_set_default_soil_properties_THEN_values_not_set(self):
self.clean_database()
self.user = self.login()
self.create_model_run_with_user_uploaded_driving_data()
model_run = self.set_model_run_latlon(self.user, 90, 0)
self.land_cover_service.save_default_soil_properties(model_run, self.user)
model_run = self.model_run_service.get_model_being_created_with_non_default_parameter_values(self.user)
nvars = model_run.get_python_parameter_value(constants.JULES_PARAM_SOIL_PROPS_NVARS)
var = model_run.get_python_parameter_value(constants.JULES_PARAM_SOIL_PROPS_VAR)
use_file = model_run.get_python_parameter_value(constants.JULES_PARAM_SOIL_PROPS_USE_FILE, is_list=True)
const_val = model_run.get_python_parameter_value(constants.JULES_PARAM_SOIL_PROPS_CONST_VAL, is_list=True)
assert_that(nvars, is_(None))
assert_that(var, is_(None))
assert_that(use_file, is_(None))
assert_that(const_val, is_(None))
def set_model_run_latlon(self, user, lat, lon):
params_to_save = [[constants.JULES_PARAM_POINTS_FILE, [lat, lon]]]
params_to_del = constants.JULES_PARAM_POINTS_FILE
self.parameter_service.save_new_parameters(params_to_save, params_to_del, user.id)
return self.model_run_service.get_model_being_created_with_non_default_parameter_values(user)
class TestLandCoverServiceForCreateAndModifyCategoriesAndRegions(TestController):
def setUp(self):
dap_client_factory =Mock(DapClientFactory)
self.land_cover_service = LandCoverService(dap_client_factory=dap_client_factory)
self.model_run_service = ModelRunService()
self.dataset_service = DatasetService()
self.clean_database()
self.user = self.login()
def create_values(self, expected_categories, expected_names, expected_paths, expected_ids):
values = []
for name, category, path, id in zip(expected_names, expected_categories, expected_paths, expected_ids):
values.append({
'id': id,
'name': name,
'category': category,
'path': path})
return values
def assert_regions_are_correct(self, driving_dataset, expected_categories, expected_names, expected_paths, values):
with session_scope() as session:
regions = LandCoverService().get_land_cover_regions(driving_dataset.id)
assert_that(len(regions), is_(len(values)), "number of regions")
for name, category, path, region in zip(expected_names, expected_categories, expected_paths, regions):
assert_that(region.name, is_(name), "name")
assert_that(region.category.name, is_(category), "category")
assert_that(region.mask_file, is_(path), "path")
return regions
def test_GIVEN_no_values_WHEN_add_to_new_dataset_THEN_nothing_changes(self):
with session_scope() as session:
driving_dataset = self.create_driving_dataset(session)
#WHEN
self.land_cover_service.update_regions_and_categories_in_session(session, driving_dataset, [])
with session_scope() as session:
regions = LandCoverService().get_land_cover_regions(driving_dataset.id)
assert_that(len(regions), is_(0), "number of regions")
def test_GIVEN_one_values_WHEN_add_to_new_dataset_THEN_value_is_added(self):
expected_names = ["name"]
expected_categories = ["category"]
expected_paths = ["expected_paths"]
expected_ids = [""]
values = self.create_values(expected_categories, expected_names, expected_paths, expected_ids)
with session_scope() as session:
driving_dataset = self.create_driving_dataset(session)
#WHEN
self.land_cover_service.update_regions_and_categories_in_session(session, driving_dataset, values)
self.assert_regions_are_correct(driving_dataset, expected_categories, expected_names, expected_paths, values)
def test_GIVEN_two_values_with_different_categories_WHEN_add_to_new_dataset_THEN_values_are_added(self):
expected_names = ["name", "name2"]
expected_categories = ["category", "category2"]
expected_paths = ["expected_paths", "expected_path2"]
expected_ids = [""]
values = self.create_values(expected_categories, expected_names, expected_paths, expected_ids)
with session_scope() as session:
driving_dataset = self.create_driving_dataset(session)
#WHEN
self.land_cover_service.update_regions_and_categories_in_session(session, driving_dataset, values)
self.assert_regions_are_correct(driving_dataset, expected_categories, expected_names, expected_paths, values)
def test_GIVEN_two_values_with_same_categories_WHEN_add_to_new_dataset_THEN_values_are_added_only_one_category(self):
expected_names = ["name", "name2"]
expected_categories = ["category", "category"]
expected_paths = ["expected_paths", "expected_path2"]
expected_ids = ["", ""]
values = self.create_values(expected_categories, expected_names, expected_paths, expected_ids)
with session_scope() as session:
driving_dataset = self.create_driving_dataset(session)
#WHEN
self.land_cover_service.update_regions_and_categories_in_session(session, driving_dataset, values)
regions = self.assert_regions_are_correct(driving_dataset, expected_categories, expected_names, expected_paths, values)
assert_that(regions[0].category, same_instance(regions[1].category), "categories are the same")
def test_GIVEN_one_value_WHEN_add_to_existing_empty_dataset_THEN_value_is_added(self):
expected_names = ["name"]
expected_categories = ["category"]
expected_paths = ["expected_paths"]
expected_ids = [""]
values = self.create_values(expected_categories, expected_names, expected_paths, expected_ids)
with session_scope() as session:
driving_dataset = self.create_driving_dataset(session)
with session_scope() as session:
driving_dataset = session.query(DrivingDataset).get(driving_dataset.id)
self.land_cover_service.update_regions_and_categories_in_session(session, driving_dataset, values)
self.assert_regions_are_correct(driving_dataset, expected_categories, expected_names, expected_paths, values)
def test_GIVEN_one_value_WHEN_add_to_existing_dataset_with_mask_in_already_THEN_value_is_modified(self):
with session_scope() as session:
driving_dataset = DrivingDataset()
original = self.create_values(["orig"], ["category"], ["orig"], [""])
self.land_cover_service.update_regions_and_categories_in_session(session, driving_dataset, original)
session.add(driving_dataset)
regions = self.land_cover_service.get_land_cover_regions(driving_dataset.id)
expected_ids = [regions[0].id]
expected_names = ["name"]
expected_categories = ["category"]
expected_paths = ["expected_paths"]
values = self.create_values(expected_categories, expected_names, expected_paths, expected_ids)
with session_scope() as session:
driving_dataset = session.query(DrivingDataset).get(driving_dataset.id)
self.land_cover_service.update_regions_and_categories_in_session(session, driving_dataset, values)
self.assert_regions_are_correct(driving_dataset, expected_categories, expected_names, expected_paths, values)
def test_GIVEN_one_value_WHEN_add_to_existing_dataset_with_mask_in_already_in_different_category_THEN_value_is_modified_and_only_one_category(self):
with session_scope() as session:
driving_dataset = DrivingDataset()
original = self.create_values(["orig"], ["orig"], ["orig"], [""])
self.land_cover_service.update_regions_and_categories_in_session(session, driving_dataset, original)
session.add(driving_dataset)
regions = self.land_cover_service.get_land_cover_regions(driving_dataset.id)
expected_ids = [regions[0].id]
expected_names = ["name"]
expected_categories = ["category"]
expected_paths = ["expected_paths"]
values = self.create_values(expected_categories, expected_names, expected_paths, expected_ids)
with session_scope() as session:
driving_dataset = session.query(DrivingDataset).get(driving_dataset.id)
self.land_cover_service.update_regions_and_categories_in_session(session, driving_dataset, values)
self.assert_regions_are_correct(driving_dataset, expected_categories, expected_names, expected_paths, values)
categories = self.land_cover_service.get_land_cover_categories(driving_dataset.id)
assert_that(len(categories), is_(1), "number of categories")
