def testConfigUniverseGetUnitsForMeasurementMultipleNoUnits(self):
doc = {
'powerfactor': [{
'no_units': 'STANDARD'
}, 'another_one'],
'voltageratio': [{
'no_units': 'STANDARD'
}],
}
folder = unit_lib.UnitFolder('units/anyfolder')
folder.AddFromConfig([doc], 'units/anyfolder/units.yaml')
unit_universe = unit_lib.UnitUniverse([folder])
config_universe = presubmit_validate_types_lib.ConfigUniverse(
subfield_universe=None,
field_universe=None,
entity_type_universe=None,
state_universe=None,
connection_universe=None,
unit_universe=unit_universe)
units1 = config_universe.GetUnitsForMeasurement('powerfactor_sensor')
units2 = config_universe.GetUnitsForMeasurement('voltageratio_sensor')
self.assertSameElements(['no_units', 'another_one'], units1)
self.assertSameElements(['no_units'], units2)
def testConfigUniverseGetEntityType(self):
context = findings_lib.FileContext('')
type_universe = entity_type_lib.EntityTypeUniverse([])
type_universe.AddFinding(
findings_lib.IllegalCharacterError('stuff', context))
field_universe = field_lib.FieldUniverse([])
field_universe.AddFinding(
findings_lib.InconsistentFileLocationError('', context))
subfield_universe = subfield_lib.SubfieldUniverse([])
subfield_universe.AddFinding(
findings_lib.CapitalizationError('Hi', context))
state_universe = state_lib.StateUniverse([])
connection_universe = connection_lib.ConnectionUniverse([])
unit_universe = unit_lib.UnitUniverse([])
config_universe = presubmit_validate_types_lib.ConfigUniverse(
subfield_universe=subfield_universe,
field_universe=field_universe,
entity_type_universe=type_universe,
state_universe=state_universe,
connection_universe=connection_universe,
unit_universe=unit_universe)
entity_type = config_universe.GetEntityType('NONEXISTENT',
'NONEXISTENT')
self.assertIsNone(entity_type)
def testConfigUniverseGetUnitsForMeasurement(self):
folder = unit_lib.UnitFolder('units/anyfolder')
namespace = folder.local_namespace
namespace.InsertUnit(
unit_lib.Unit('degrees_celsius', 'temperature', False))
namespace.InsertUnit(unit_lib.Unit('kelvin', 'temperature', True))
unit_universe = unit_lib.UnitUniverse([folder])
config_universe = presubmit_validate_types_lib.ConfigUniverse(
subfield_universe=None,
field_universe=None,
entity_type_universe=None,
state_universe=None,
connection_universe=None,
unit_universe=unit_universe)
units = config_universe.GetUnitsForMeasurement(
'zone_temperature_sensor')
self.assertSameElements(['degrees_celsius', 'kelvin'], units)
units = config_universe.GetUnitsForMeasurement('temperature_sensor')
self.assertSameElements(['degrees_celsius', 'kelvin'], units)
units = config_universe.GetUnitsForMeasurement(
'/zone_temperature_sensor')
self.assertSameElements(['degrees_celsius', 'kelvin'], units)
units = config_universe.GetUnitsForMeasurement('/temperature_sensor')
self.assertSameElements(['degrees_celsius', 'kelvin'], units)
units = config_universe.GetUnitsForMeasurement('pressure_sensor')
self.assertIsNone(units)
units = config_universe.GetUnitsForMeasurement(
'discharge_fan_lost_power_alarm')
self.assertIsNone(units)
def testUnitUniverseGetFindings(self):
context = findings_lib.FileContext('{0}/file.yaml'.format(_GOOD_PATH))
folder = unit_lib.UnitFolder(_GOOD_PATH)
folder.AddFinding(
findings_lib.InconsistentFileLocationError('', context))
namespace = folder.local_namespace
namespace.AddFinding(
findings_lib.DuplicateUnitDefinitionError(
unit_lib.Unit('unit', 'measurement'), 'namespace'))
unit = unit_lib.Unit('unit', 'measurement')
unit.AddFinding(
findings_lib.UnknownUnitTagError(unit.name, 'tag', context))
namespace.InsertUnit(unit)
unit_universe = unit_lib.UnitUniverse([folder])
findings = unit_universe.GetFindings()
self.assertLen(findings, 3)
self.assertTrue(
unit_universe.HasFindingTypes([
findings_lib.InconsistentFileLocationError,
findings_lib.DuplicateUnitDefinitionError,
findings_lib.UnknownUnitTagError,
]))
self.assertFalse(unit_universe.IsValid())
def testConfigUniverse(self):
context = findings_lib.FileContext('')
type_universe = entity_type_lib.EntityTypeUniverse([])
type_universe.AddFinding(
findings_lib.IllegalCharacterError('stuff', context))
field_universe = field_lib.FieldUniverse([])
field_universe.AddFinding(
findings_lib.InconsistentFileLocationError('', context))
subfield_universe = subfield_lib.SubfieldUniverse([])
subfield_universe.AddFinding(
findings_lib.CapitalizationError('Hi', context))
state_universe = state_lib.StateUniverse([])
connection_universe = connection_lib.ConnectionUniverse([])
connection_universe.AddFinding(
findings_lib.InvalidConnectionNamespaceError('notglobal', context))
unit_universe = unit_lib.UnitUniverse([])
config_universe = presubmit_validate_types_lib.ConfigUniverse(
subfield_universe=subfield_universe,
field_universe=field_universe,
entity_type_universe=type_universe,
state_universe=state_universe,
connection_universe=connection_universe,
unit_universe=unit_universe)
findings = config_universe.GetFindings()
self.assertLen(findings, 4)
self.assertTrue(
config_universe.HasFindingTypes([
findings_lib.InconsistentFileLocationError,
findings_lib.IllegalCharacterError,
findings_lib.CapitalizationError,
findings_lib.InvalidConnectionNamespaceError
]))
self.assertFalse(config_universe.IsValid())
def testParseSubfieldFoldersFromGlobalFileWithUnitValidation(self):
unit_folders = parse.ParseUnitFoldersFromFiles(
[self.global_units_file])
unit_universe = unit_lib.UnitUniverse(unit_folders)
subfield_folders = parse.ParseSubfieldFoldersFromFiles(
[self.global_subfields_file])
local_folder = subfield_folders[0]
local_folder.ValidateUnits(unit_universe)
self.assertEmpty(local_folder.GetFindings())
def BuildUniverse(config):
"""Verifies that the ontology config is consistent and valid.
Args:
config: a Config namedtuple containing lists of localpaths to config files.
Returns:
A ConfigUniverse that is fully populated with all content specified in the
config.
"""
# Parse state files
state_universe = None
if config.states:
state_folders = parse.ParseStateFoldersFromFiles(config.states)
state_universe = state_lib.StateUniverse(state_folders)
connections_universe = None
if config.connections:
connection_folders = parse.ParseConnectionFoldersFromFiles(
config.connections)
connections_universe = connection_lib.ConnectionUniverse(
connection_folders)
# Parse subfield files
subfields_universe = None
if config.subfields:
subfield_folders = parse.ParseSubfieldFoldersFromFiles(
config.subfields)
subfields_universe = subfield_lib.SubfieldUniverse(subfield_folders)
# Parse unit files
unit_universe = None
if config.units:
unit_folders = parse.ParseUnitFoldersFromFiles(config.units,
subfields_universe)
unit_universe = unit_lib.UnitUniverse(unit_folders)
if subfields_universe:
subfields_universe.ValidateUnits(unit_universe)
# Parse fields files
fields_universe = None
if config.fields:
field_folders = parse.ParseFieldFoldersFromFiles(
config.fields, subfields_universe, state_universe)
fields_universe = field_lib.FieldUniverse(field_folders)
# Parse typedef files
type_folders = parse.ParseTypeFoldersFromFiles(config.type_defs,
fields_universe)
types_universe = entity_type_lib.EntityTypeUniverse(type_folders)
# return findings_list, result_namespaces
return ConfigUniverse(types_universe, fields_universe, subfields_universe,
state_universe, connections_universe, unit_universe)
def testUnitUniverseGetUnitsMap(self):
folder = unit_lib.UnitFolder(_GOOD_PATH)
namespace = folder.local_namespace
namespace.InsertUnit(
unit_lib.Unit('degrees_celsius', 'temperature', False))
namespace.InsertUnit(unit_lib.Unit('kelvins', 'temperature', True))
unit_universe = unit_lib.UnitUniverse([folder])
units = unit_universe.GetUnitsMap('mynamespace')
self.assertIn('degrees_celsius', units)
self.assertIn('kelvins', units)
def testUnitUniverseGetUnitsForMeasurement(self):
folder = unit_lib.UnitFolder(_GOOD_PATH)
namespace = folder.local_namespace
namespace.InsertUnit('temperature',
unit_lib.Unit('degrees_celsius', False))
namespace.InsertUnit('temperature', unit_lib.Unit('kelvins', True))
namespace.InsertUnit('percent', unit_lib.Unit('percent', True))
unit_universe = unit_lib.UnitUniverse([folder])
units = unit_universe.GetUnitsForMeasurement('temperature',
'mynamespace')
self.assertCountEqual(['degrees_celsius', 'kelvins'], units)
def testParseSubfieldFoldersFromBadFileWithUnitValidation(self):
unit_folders = parse.ParseUnitFoldersFromFiles(
[self.global_units_file])
unit_universe = unit_lib.UnitUniverse(unit_folders)
bad_subfields = base_lib.PathParts(
root=self.base_dir,
relative_path='BAD/subfields/missing_unit_subfields.yaml')
subfield_folders = parse.ParseSubfieldFoldersFromFiles([bad_subfields])
local_folder = subfield_folders[0]
local_folder.ValidateUnits(unit_universe)
self.assertTrue(subfield_folders[0].HasFindingTypes(
[findings_lib.MissingUnitError]))
def testFindingAddedForInvalidNamespace(self):
folder = unit_lib.UnitFolder(_GOOD_PATH)
namespace = folder.local_namespace
namespace.parent_namespace = unit_lib.UnitNamespace('fake_parent')
namespace.InsertUnit('temperature',
unit_lib.Unit('degrees_celsius', False))
unit_universe = unit_lib.UnitUniverse([folder])
findings_universe = findings_lib.FindingsUniverse([folder])
findings = findings_universe.GetFindings()
self.assertLen(findings, 1)
self.assertTrue(
unit_universe.HasFindingTypes(
[findings_lib.InvalidUnitNamespaceError]))
self.assertFalse(unit_universe.IsValid())
def create_simplified_universe(
) -> presubmit_validate_types_lib.ConfigUniverse:
"""Creates a simplified test universe with minimal configuration for testing.
Returns:
config_universe a partially defined ConfigUniverse
"""
# constant universes
state_universe = states.STATE_UNIVERSE
connection_universe = connections.CONNECTION_UNIVERSE
subfield_universe = subfields.SUBFIELD_UNIVERSE
# update unit folder with subfield_universe
unit_folder = unit_lib.UnitFolder(folderpath='units')
unit_folder.local_namespace.subfields = subfield_universe.GetSubfieldsMap(
unit_folder.local_namespace.namespace)
unit_folder.AddFromConfig(config_filename='units/units.yaml',
documents=[units.UNIT_DOCUMENT])
unit_universe = unit_lib.UnitUniverse(folders=[unit_folder])
# subfield universe has to validate unit universe
subfield_universe.ValidateUnits(unit_universe)
# field universe depends on subfield and state universes
field_folder = field_lib.FieldFolder(folderpath='fields')
field_folder.local_namespace.subfields = subfield_universe.GetSubfieldsMap(
field_folder.local_namespace.namespace)
field_folder.local_namespace.states = state_universe.GetStatesMap(
field_folder.local_namespace.namespace)
field_folder.AddFromConfig(config_filename='fields/telemetry_fields.yaml',
documents=[fields.TELEMETRY_FIELDS_DOCUMENT])
field_folder.AddFromConfig(config_filename='fields/metadata_fields.yaml',
documents=[fields.METADATA_FIELDS_DOCUMENT])
field_universe = field_lib.FieldUniverse(folders=[field_folder])
# entity type universe depends on field universe
global_type_folder = entity_type_lib.EntityTypeFolder(
folderpath='entity_types', field_universe=field_universe)
facilities_type_folder = entity_type_lib.EntityTypeFolder(
folderpath='FACILITIES/entity_types', field_universe=field_universe)
hvac_type_folder = entity_type_lib.EntityTypeFolder(
folderpath='HVAC/entity_types', field_universe=field_universe)
global_type_folder.AddFromConfig(
config_filename='entity_types/global.yaml',
documents=[types.GLOBAL_TYPES_DOCUMENT])
facilities_type_folder.AddFromConfig(
config_filename='FACILITIES/entity_types/Facilities.yaml',
documents=[types.FACILITIES_TYPES_DOCUMENT])
hvac_type_folder.AddFromConfig(
config_filename='HVAC/entity_types/ANALYSIS.yaml',
documents=[types.HVAC_ANALYSIS_TYPES_DOCUMENT])
hvac_type_folder.AddFromConfig(
config_filename='HVAC/entity_types/ABSTRACT.yaml',
documents=[types.HVAC_ABSTRACT_TYPES_DOCUMENT])
hvac_type_folder.AddFromConfig(
config_filename='HVAC/entity_types/CHWS.yaml',
documents=[types.HVAC_CHWS_TYPES_DOCUMENT])
hvac_type_folder.AddFromConfig(
config_filename='HVAC/entity_types/GENERALTYPES.yaml',
documents=[types.HVAC_GENERAL_TYPES_DOCUMENT])
hvac_type_folder.AddFromConfig(
config_filename='HVAC/entity_types/SDC.yaml',
documents=[types.HVAC_SDC_TYPES_DOCUMENT])
hvac_type_folder.AddFromConfig(
config_filename='HVAC/entity_types/DMP.yaml',
documents=[types.HVAC_DMP_TYPES_DOCUMENT])
entity_type_universe = entity_type_lib.EntityTypeUniverse(
entity_type_folders=[
global_type_folder, facilities_type_folder, hvac_type_folder
])
config_universe = presubmit_validate_types_lib.ConfigUniverse(
entity_type_universe=entity_type_universe,
field_universe=field_universe,
subfield_universe=subfield_universe,
state_universe=state_universe,
connection_universe=connection_universe,
unit_universe=unit_universe)
# call this to expand inherited fields
namespace_validator.NamespaceValidator(
config_universe.GetEntityTypeNamespaces())
return config_universe
