def test_publication_version_view(self):
parser = et.HTMLParser()
query_limit = FuzzyInt(0, 20)
with self.assertNumQueries(query_limit):
request_url = reverse("publication_version", kwargs={
"project_name": self.test_project.name,
"ontology_key": self.test_ontology.get_key(),
"document_type": self.test_proxy.name.lower(),
"publication_name": self.test_realization.get_key(),
"publication_version": "1.0.0",
})
response = self.client.get(request_url)
self.assertEqual(response.status_code, 200)
tree_node = et.parse(StringIO.StringIO(response.content), parser)
model = get_index(xpath_fix(tree_node, "//model"), 0)
self.assertIsNotNone(model)
self.assertEqual(response.content, self.publication_v1.content)
# now test that an invalid version fails...
with self.assertNumQueries(query_limit):
request_url = reverse("publication_version", kwargs={
"project_name": self.test_project.name,
"ontology_key": self.test_ontology.get_key(),
"document_type": self.test_proxy.name.lower(),
"publication_name": self.test_realization.get_key(),
"publication_version": "invalid",
})
response = self.client.get(request_url)
self.assertEqual(response.status_code, 400)
def register_cim1(self, **kwargs):
request = kwargs.pop("request", None)
try:
self.file.open()
ontology_content = et.parse(self.file)
self.file.close()
except IOError:
msg = "Error opening file: %s" % self.file
if request:
messages.add_message(request, messages.ERROR, msg)
return
recategorization_needed = False
old_model_proxies = list(self.model_proxies.all()) # list forces qs evaluation immediately
new_model_proxies = []
for i, model_proxy in enumerate(xpath_fix(ontology_content, "//classes/class")):
model_proxy_ontology = self
model_proxy_name = xpath_fix(model_proxy, "name/text()")[0]
model_proxy_stereotype = get_index(xpath_fix(model_proxy, "@stereotype"), 0)
model_proxy_namespace = get_index(xpath_fix(model_proxy, "@namespace"), 0)
model_proxy_package = get_index(xpath_fix(model_proxy, "@package"), 0)
model_proxy_documentation = get_index(xpath_fix(model_proxy, "description/text()"), 0)
if model_proxy_documentation:
model_proxy_documentation = remove_spaces_and_linebreaks(model_proxy_documentation)
else:
model_proxy_documentation = u""
(new_model_proxy, created_model_proxy) = QModelProxy.objects.get_or_create(
ontology=model_proxy_ontology,
name=model_proxy_name,
)
if created_model_proxy:
recategorization_needed = True
new_model_proxy.order = i + 1
new_model_proxy.stereotype = model_proxy_stereotype
new_model_proxy.namespace = model_proxy_namespace
new_model_proxy.package = model_proxy_package
new_model_proxy.documentation = model_proxy_documentation
new_model_proxy.save()
new_model_proxies.append(new_model_proxy)
old_property_proxies = list(new_model_proxy.standard_properties.all()) # list forces qs evaluation immediately
new_property_proxies = []
for j, property_proxy in enumerate(xpath_fix(model_proxy, "attributes/attribute")):
property_proxy_name = re.sub(r'\.', '_', str(xpath_fix(property_proxy, "name/text()")[0]))
property_proxy_field_type = xpath_fix(property_proxy, "type/text()")[0]
property_proxy_is_label = get_index(xpath_fix(property_proxy, "@is_label"), 0)
property_proxy_stereotype = get_index(xpath_fix(property_proxy, "@stereotype"), 0)
property_proxy_namespace = get_index(xpath_fix(property_proxy, "@namespace"), 0)
property_proxy_required = get_index(xpath_fix(property_proxy, "@required"), 0)
property_proxy_documentation = get_index(xpath_fix(property_proxy, "description/text()"), 0)
if property_proxy_documentation:
property_proxy_documentation = remove_spaces_and_linebreaks(property_proxy_documentation)
else:
property_proxy_documentation = u""
property_proxy_atomic_type = get_index(xpath_fix(property_proxy, "atomic/atomic_type/text()"), 0)
if property_proxy_atomic_type:
if property_proxy_atomic_type == u"STRING":
property_proxy_atomic_type = u"DEFAULT"
property_proxy_atomic_type = QAtomicPropertyTypes.get(property_proxy_atomic_type)
property_proxy_enumeration_choices = []
for property_proxy_enumeration_choice in xpath_fix(property_proxy, "enumeration/choice"):
property_proxy_enumeration_choices.append(xpath_fix(property_proxy_enumeration_choice, "text()")[0])
property_proxy_relationship_cardinality_min = get_index(xpath_fix(property_proxy, "relationship/cardinality/@min"), 0)
property_proxy_relationship_cardinality_max = get_index(xpath_fix(property_proxy, "relationship/cardinality/@max"), 0)
property_proxy_relationship_target_name = get_index(xpath_fix(property_proxy, "relationship/target/text()"), 0)
(new_property_proxy, created_property) = QStandardPropertyProxy.objects.get_or_create(
model_proxy=new_model_proxy,
name=property_proxy_name,
field_type=property_proxy_field_type
)
if created_property:
recategorization_needed = True
new_property_proxy.order = j + 1
new_property_proxy.documentation = property_proxy_documentation
new_property_proxy.is_label = property_proxy_is_label == "true"
new_property_proxy.stereotype = property_proxy_stereotype
new_property_proxy.namespace = property_proxy_namespace
if property_proxy_field_type == QPropertyTypes.RELATIONSHIP:
if property_proxy_relationship_cardinality_min and property_proxy_relationship_cardinality_max:
new_property_proxy.cardinality = u"%s|%s" % (property_proxy_relationship_cardinality_min, property_proxy_relationship_cardinality_max)
else:
if property_proxy_required:
new_property_proxy.cardinality = u"1|1"
new_property_proxy.atomic_type = property_proxy_atomic_type
new_property_proxy.enumeration_choices = "|".join(property_proxy_enumeration_choices)
new_property_proxy.relationship_target_name = property_proxy_relationship_target_name
new_property_proxy.save()
new_property_proxies.append(new_property_proxy)
# if there's anything in old_property_proxies not in new_property_proxies, delete it
for old_property_proxy in old_property_proxies:
if old_property_proxy not in new_property_proxies:
old_property_proxy.delete()
new_model_proxy.save() # save parent again for the m2m relationship
# if there's anything in old_model_proxies not in new_model_proxies, delete it
for old_model_proxy in old_model_proxies:
if old_model_proxy not in new_model_proxies:
old_model_proxy.delete()
# reset whatever's left
for model_proxy in QModelProxy.objects.filter(ontology=self):
for property_proxy in model_proxy.standard_properties.all():
property_proxy.reset()
property_proxy.save()
if recategorization_needed:
msg = "Since you are re-registering an existing version, you will also have to re-register the corresponding categorization"
if request:
messages.add_message(request, messages.WARNING, msg)
def create_component_proxy(self, component_proxy_node, parent_component_proxy=None):
"""
recursively create component proxies, keeping track of their hierarchy
:param component_proxy_node:
:param parent_component_proxy:
:return:
"""
self.component_order += 1
component_proxy_vocabulary = self
component_proxy_name = get_index(xpath_fix(component_proxy_node, "@name"), 0)
component_proxy_order = self.component_order
component_proxy_documentation = get_index(xpath_fix(component_proxy_node, "definition/text()"), 0)
if component_proxy_documentation:
component_proxy_documentation = remove_spaces_and_linebreaks(component_proxy_documentation)
(new_component_proxy, created_component_proxy) = QComponentProxy.objects.get_or_create(
vocabulary=component_proxy_vocabulary,
name=component_proxy_name,
parent=parent_component_proxy
)
new_component_proxy.documentation = component_proxy_documentation
new_component_proxy.order = component_proxy_order
new_component_proxy.save()
old_category_proxies = list(new_component_proxy.category_proxies.all()) # list forces qs evaluation immediately
new_category_proxies = []
category_proxy_component = new_component_proxy
for i, category_proxy_node in enumerate(xpath_fix(component_proxy_node, "./parametergroup")):
category_proxy_name = xpath_fix(category_proxy_node, "@name")[0]
category_proxy_key = slugify(category_proxy_name)
category_proxy_order = i + 1
category_proxy_documentation = get_index(xpath_fix(category_proxy_node, "definition/text()"), 0)
if category_proxy_documentation:
category_proxy_documentation = remove_spaces_and_linebreaks(category_proxy_documentation)
(new_category_proxy, created_category_proxy) = QScientificCategoryProxy.objects.get_or_create(
component_proxy=category_proxy_component,
name=category_proxy_name
)
new_category_proxy.documentation = category_proxy_documentation
new_category_proxy.order = category_proxy_order
new_category_proxy.key = category_proxy_key
new_category_proxy.save()
new_category_proxies.append(new_category_proxy)
old_property_proxies = list(new_category_proxy.properties.all()) # list forces qs evaluation immediately
new_property_proxies = []
property_proxy_component = new_component_proxy
property_proxy_category = new_category_proxy
for j, property_proxy_node in enumerate(xpath_fix(category_proxy_node, "./parameter")):
property_proxy_name = get_index(xpath_fix(property_proxy_node, "@name"), 0)
property_proxy_choice = get_index(xpath_fix(property_proxy_node, "@choice"), 0)
property_proxy_order = j + 1
property_proxy_documentation = get_index(xpath_fix(property_proxy_node, "definition/text()"), 0)
if property_proxy_documentation:
property_proxy_documentation = remove_spaces_and_linebreaks(property_proxy_documentation)
property_proxy_enumeration_values = []
for property_proxy_enumeration_value in xpath_fix(property_proxy_node, "value"):
property_proxy_enumeration_value_name = get_index(xpath_fix(property_proxy_enumeration_value, "@name"), 0)
if property_proxy_enumeration_value_name:
property_proxy_enumeration_values.append(property_proxy_enumeration_value_name)
(new_property_proxy, created_property_proxy) = QScientificPropertyProxy.objects.get_or_create(
component_proxy=property_proxy_component,
category=property_proxy_category,
name=property_proxy_name,
)
new_property_proxy.choice = property_proxy_choice
new_property_proxy.documentation = property_proxy_documentation
new_property_proxy.order = property_proxy_order
new_property_proxy.enumeration_choices = "|".join(property_proxy_enumeration_values)
new_property_proxy.save()
new_property_proxies.append(new_property_proxy)
# if there's anything in old_property_proxies not in new_property_proxies, delete it
for old_property_proxy in old_property_proxies:
if old_property_proxy not in new_property_proxies:
old_property_proxy.delete()
# reset whatever's left
for property_proxy in QScientificPropertyProxy.objects.filter(component_proxy=new_component_proxy, category=new_category_proxy):
property_proxy.reset()
property_proxy.save()
# if there's anything in old_category_proxies not in new_category_proxies, delete it
for old_category_proxy in old_category_proxies:
if old_category_proxy not in new_category_proxies:
old_category_proxy.delete()
# recurse
for child_component_proxy_node in xpath_fix(component_proxy_node, "./component"):
self.create_component_proxy(child_component_proxy_node, new_component_proxy)
# (do this last in case any m2m fields are added recursively)
self.new_component_proxies.append(new_component_proxy)
name_node.text = str(QNillableTypes.TEMPLATE)
version_node = et.Element("version")
version_node.text = str(QNillableTypes.TEMPLATE)
categories_node = et.Element("categories")
categories_node.text = str(QNillableTypes.TEMPLATE)
models_node = et.Element("models")
root_node.append(comment_node)
root_node.append(name_node)
root_node.append(version_node)
root_node.append(categories_node)
root_node.append(models_node)
for model in xpath_fix(qxml_content, "//classes/class[@stereotype='document']"):
model_node = et.Element("model")
model_name_node = et.Element("name")
model_package = get_index(xpath_fix(model, "@package"), 0)
model_name = get_index(xpath_fix(model, "name/text()"), 0)
if model_package:
model_name_node.text = "{0}.{1}".format(model_package, model_name)
else:
model_name_node.text = model_name
model_fields_node = et.Element("fields")
for field in xpath_fix(model, "attributes/attribute"):
field_node = et.Element("field")
field_name_node = et.Element("name")
field_name_node.text = xpath_fix(field, "name/text()")[0]
field_category_node = et.Element("category_key")
field_category_node.text = str(QNillableTypes.TEMPLATE)
field_node.append(field_name_node)
field_node.append(field_category_node)
model_fields_node.append(field_node)
def register(self, **kwargs):
request = kwargs.pop("request", None)
try:
self.file.open()
categorization_content = et.parse(self.file)
self.file.close()
except IOError:
msg = "Error opening file: %s" % self.file
if request:
messages.add_message(request, messages.ERROR, msg)
return
ontologies = self.ontologies.all()
if not ontologies:
msg = "QCategorization '%s' has not been associated with any ontologies. It's kind of silly to register it now." % (self)
if request:
messages.add_message(request, messages.WARNING, msg)
else:
print(msg)
old_category_proxies = list(self.category_proxies.all()) # list forces qs evaluation immediately
new_category_proxies = []
for i, category_proxy in enumerate(xpath_fix(categorization_content, "//category")):
category_proxy_categorization = self
category_proxy_name = get_index(xpath_fix(category_proxy, "name/text()"), 0)
category_proxy_key = get_index(xpath_fix(category_proxy, "key/text()"), 0)
category_proxy_order = get_index(xpath_fix(category_proxy, 'order/text()'), 0)
category_proxy_documentation = get_index(xpath_fix(category_proxy, "description/text()"), 0)
if category_proxy_documentation:
category_proxy_documentation = remove_spaces_and_linebreaks(category_proxy_documentation)
(new_category_proxy, created_category) = QStandardCategoryProxy.objects.get_or_create(
categorization=category_proxy_categorization,
name=category_proxy_name,
)
new_category_proxy.documentation = category_proxy_documentation
new_category_proxy.key = category_proxy_key or slugify(category_proxy_name)
new_category_proxy.order = category_proxy_order or i
if not created_category:
# remove any existing relationships (going to replace them during this registration)...
new_category_proxy.properties.clear()
for j, field in enumerate(xpath_fix(categorization_content, "//field[category_key='%s']" % new_category_proxy.key)):
model_name = get_index(xpath_fix(field, "./ancestor::model/name/text()"), 0)
field_name = get_index(xpath_fix(field, "name/text()"), 0)
for ontology in ontologies:
try:
model_proxy = ontology.model_proxies.get(name__iexact=model_name)
property_proxy = model_proxy.standard_properties.get(name__iexact=field_name)
new_category_proxy.properties.add(property_proxy)
except QModelProxy.DoesNotExist:
msg = "Unable to find QModel '%s' specified in QCategorization '%s'" % (model_name, self)
if request:
messages.add_message(request, messages.WARNING, msg)
else:
print(msg)
pass
except QStandardPropertyProxy.DoesNotExist:
msg = "Unable to find QStandardProperty '%s' specified in QCategorization '%s'" % (field_name, self)
if request:
messages.add_message(request, messages.WARNING, msg)
else:
print(msg)
pass
new_category_proxy.save()
new_category_proxies.append(new_category_proxy)
self.is_registered = True
self.last_registered_version = self.version
def parse_schema(self, **kwargs):
"""
registers a CIM2 ontology schema QXML file
:param kwargs:
:return:
"""
request = kwargs.pop("request", None)
try:
self.file.open()
ontology_content = et.parse(self.file)
self.file.close()
except IOError as e:
msg = "Error opening file: {0}".format(self.file)
if request:
messages.add_message(request, messages.ERROR, msg)
raise e
recategorization_needed = False
# name can be anything...
ontology_name = get_index(xpath_fix(ontology_content, "name/text()"), 0)
# version should match(ish) the instance field...
ontology_version = get_index(xpath_fix(ontology_content, "version/text()"), 0)
if self.version.major() != Version(ontology_version).major():
msg = "The major version of this ontology instance does not match the major version of the QXML file"
if request:
messages.add_message(request, messages.WARNING, msg)
# description can overwrite the instance field...
ontology_description = get_index(xpath_fix(ontology_content, "description/text()"), 0)
if ontology_description:
self.description = remove_spaces_and_linebreaks(ontology_description)
old_model_proxies = list(self.model_proxies.all()) # list forces qs evaluation immediately
new_model_proxies = []
for i, model_proxy in enumerate(xpath_fix(ontology_content, "//classes/class"), start=1):
model_proxy_package = xpath_fix(model_proxy, "@package")[0]
model_proxy_schema = self
model_proxy_name = xpath_fix(model_proxy, "name/text()")[0]
model_proxy_stereotype = get_index(xpath_fix(model_proxy, "@stereotype"), 0)
model_proxy_documentation = get_index(xpath_fix(model_proxy, "description/text()"), 0)
if model_proxy_documentation:
model_proxy_documentation = remove_spaces_and_linebreaks(model_proxy_documentation)
else:
model_proxy_documentation = u""
(new_model_proxy, created_model_proxy) = QModelProxy.objects.get_or_create(
package=model_proxy_package, ontology=model_proxy_schema, name=model_proxy_name
)
if created_model_proxy:
recategorization_needed = True
new_model_proxy.order = i
new_model_proxy.stereotype = model_proxy_stereotype
new_model_proxy.documentation = model_proxy_documentation
new_model_proxy.save()
new_model_proxies.append(new_model_proxy)
old_property_proxies = list(new_model_proxy.property_proxies.all()) # list forces qs evaluation immediately
new_property_proxies = []
for j, property_proxy in enumerate(xpath_fix(model_proxy, "attributes/attribute"), start=1):
property_proxy_name = re.sub(r"\.", "_", str(xpath_fix(property_proxy, "name/text()")[0]))
property_proxy_field_type = xpath_fix(property_proxy, "type/text()")[0]
property_proxy_stereotype = get_index(xpath_fix(property_proxy, "@stereotype"), 0)
property_proxy_documentation = get_index(xpath_fix(property_proxy, "description/text()"), 0)
if property_proxy_documentation:
property_proxy_documentation = remove_spaces_and_linebreaks(property_proxy_documentation)
else:
property_proxy_documentation = u""
property_proxy_cardinality_min = get_index(xpath_fix(property_proxy, "cardinality/@min"), 0)
property_proxy_cardinality_max = get_index(xpath_fix(property_proxy, "cardinality/@max"), 0)
property_proxy_is_nillable = get_index(xpath_fix(property_proxy, "@is_nillable"), 0)
(new_property_proxy, created_property) = QPropertyProxy.objects.get_or_create(
model_proxy=new_model_proxy, name=property_proxy_name, field_type=property_proxy_field_type
)
if created_property:
recategorization_needed = True
new_property_proxy.order = j
new_property_proxy.documentation = property_proxy_documentation
new_property_proxy.stereotype = property_proxy_stereotype
new_property_proxy.cardinality = "{0}|{1}".format(
property_proxy_cardinality_min,
property_proxy_cardinality_max if property_proxy_cardinality_max != "N" else "*",
)
new_property_proxy.is_nillable = property_proxy_is_nillable
# atomic properties...
property_proxy_atomic_type = get_index(xpath_fix(property_proxy, "atomic/atomic_type/text()"), 0)
if property_proxy_atomic_type:
if property_proxy_atomic_type == u"STRING":
property_proxy_atomic_type = u"DEFAULT"
property_proxy_atomic_type = QAtomicPropertyTypes.get(property_proxy_atomic_type)
new_property_proxy.atomic_type = property_proxy_atomic_type
# relationship properties...
property_proxy_relationship_target_names = "|".join(
# note that each target_name is fully-qualified
xpath_fix(property_proxy, "relationship/targets/target/text()")
)
new_property_proxy.relationship_target_names = property_proxy_relationship_target_names
# enumeration properties...
property_proxy_enumeration_is_open = get_index(xpath_fix(property_proxy, "enumeration/@is_open"), 0)
property_proxy_enumeration_is_multi = get_index(xpath_fix(property_proxy, "enumeration/@is_multi"), 0)
if property_proxy_enumeration_is_open:
new_property_proxy.enumeration_is_open = property_proxy_enumeration_is_open == "true"
if property_proxy_enumeration_is_multi:
new_property_proxy.enumeration_is_multi = property_proxy_enumeration_is_multi == "true"
property_proxy_enumeration = []
for k, enumeration_member_proxy in enumerate(
xpath_fix(property_proxy, "enumeration/choices/choice"), start=1
):
enumeration_member_proxy_value = get_index(xpath_fix(enumeration_member_proxy, "value/text()"), 0)
enumeration_member_proxy_documentation = get_index(
xpath_fix(enumeration_member_proxy, "description/text()"), 0
)
property_proxy_enumeration_member = {
"order": k,
"value": enumeration_member_proxy_value,
"name": enumeration_member_proxy_value,
"documentation": enumeration_member_proxy_documentation,
}
property_proxy_enumeration.append(property_proxy_enumeration_member)
new_property_proxy.enumeration = property_proxy_enumeration
new_property_proxy.save()
new_property_proxies.append(new_property_proxy)
# if there's anything in old_property_proxies not in new_property_proxies, delete it
for old_property_proxy in old_property_proxies:
if old_property_proxy not in new_property_proxies:
old_property_proxy.delete()
new_model_proxy.save() # save parent again for the m2m relationship
# if there's anything in old_model_proxies not in new_model_proxies, delete it
for old_model_proxy in old_model_proxies:
if old_model_proxy not in new_model_proxies:
old_model_proxy.delete()
# reset whatever's left
for model_proxy in QModelProxy.objects.filter(ontology=self):
for property_proxy in model_proxy.property_proxies.all():
property_proxy.reset()
property_proxy.save()
if recategorization_needed:
msg = "Since you are re-registering an existing version, you will also have to re-register the corresponding categorization"
if request:
messages.add_message(request, messages.WARNING, msg)
