Implement text attributes

docs/manual/resource_tracking.md

@@ -64,6 +64,8 @@ Example of resource group:
 - Openshift projects
 - Openstack tenants
 
+Resource groups also have text attributes to provide some additional information.
+
 ### Resource
 
 A resource is an instance of a `resource group` definition.
@@ -128,6 +130,7 @@ We link as well the pending instance(given by `squest.instance.id`) to this reso
     vm_name: "test-vm"
     vm_vcpu: 4
     vm_memory: 16
+    desc: "My description"
 
   tasks:
     - name: Print info sent by Squest
@@ -151,6 +154,9 @@ We link as well the pending instance(given by `squest.instance.id`) to this reso
               value: "{{ vm_vcpu }}"
             - name: "Memory"
               value: "{{ vm_memory }}"
+          text_attributes:
+            - name: "Description"
+              value: "{{ desc }}"
         force_basic_auth: yes
         status_code: 201
         body_format: json

playbook_examples/add_resource_in_resource_group.yml

@@ -5,7 +5,7 @@
 
   vars:
     squest_api: "http://127.0.0.1:8000/api/"
-    resource_group_vm_id: 8
+    resource_group_name: "OCP Worker node"
     squest: # this would be the sent data from squest as extra vars
       request:
         instance:
@@ -17,6 +17,7 @@
     vm_name: "test-vm"
     vm_vcpu: 4
     vm_memory: 16
+    desc: "My description"
 
   tasks:
     - name: Print info sent by Squest
@@ -26,6 +27,21 @@
     # -----------------------
     # PLACE HERE ALL THE MAGIC TO CREATE THE RESOURCE
     # -----------------------
+    - name: Get resource group id
+      uri:
+        url: "{{ squest_api }}resource_tracker/resource_group/"
+        user: "admin"
+        password: "admin"
+        method: GET
+        force_basic_auth: yes
+        status_code: 200
+        body_format: json
+      register: output
+
+    - name: Setting host facts using complex arguments
+      set_fact:
+        resource_group_vm_id: "{{ output.json | selectattr('name', 'equalto', resource_group_name ) | map(attribute='id') | list | first  }}"
+
     - name: Create a resource in squest
       uri:
         url: "{{ squest_api }}resource_tracker/resource_group/{{ resource_group_vm_id }}/resources/"
@@ -40,6 +56,9 @@
               value: "{{ vm_vcpu }}"
             - name: "Memory"
               value: "{{ vm_memory }}"
+          text_attributes:
+            - name: "Comments"
+              value: "{{ desc }}"
         force_basic_auth: yes
         status_code: 201
-        body_format: json
+        body_format: json

profiles/forms/billing_group_forms.py

@@ -5,7 +5,6 @@
 
 class BillingGroupForm(forms.ModelForm):
     name = forms.CharField(label="Name",
-                           required=True,
                            widget=forms.TextInput(attrs={'class': 'form-control'})
                            )
 

profiles/forms/group_forms.py

@@ -18,7 +18,6 @@ def __init__(self, *args, **kwargs):
 
 class GroupForm(forms.ModelForm):
     name = forms.CharField(label="Name",
-                           required=True,
                            widget=forms.TextInput(attrs={'class': 'form-control'})
                            )
 

resource_tracker/api/serializers/resource_group_serializer.py

@@ -1,41 +1,57 @@
 from rest_framework import serializers
 from rest_framework.relations import PrimaryKeyRelatedField
 
-from resource_tracker.models import ResourceGroup, Resource, ResourceAttribute, ResourceGroupAttributeDefinition
+from resource_tracker.models import ResourceGroup, Resource, ResourceAttribute, ResourceTextAttribute, \
+    ResourceGroupAttributeDefinition, ResourceGroupTextAttributeDefinition
 from service_catalog.models import Instance
 
 
 class ResourceGroupAttributeDefinitionSerializer(serializers.ModelSerializer):
-
     class Meta:
         model = ResourceGroupAttributeDefinition
         fields = ["id", "name"]
 
 
+class ResourceGroupTextAttributeDefinitionSerializer(serializers.ModelSerializer):
+    class Meta:
+        model = ResourceGroupTextAttributeDefinition
+        fields = ["id", "name"]
+
+
 class ResourceAttributeSerializer(serializers.ModelSerializer):
+    class Meta:
+        model = ResourceAttribute
+        fields = ["name", "value"]
 
     name = serializers.SerializerMethodField(method_name="get_attribute_name")
 
     @staticmethod
     def get_attribute_name(resource_attribute):
         return resource_attribute.attribute_type.name
 
+
+class ResourceTextAttributeSerializer(serializers.ModelSerializer):
     class Meta:
-        model = ResourceAttribute
+        model = ResourceTextAttribute
         fields = ["name", "value"]
 
+    name = serializers.SerializerMethodField(method_name="get_text_attribute_name")
 
-class ResourceSerializer(serializers.ModelSerializer):
+    @staticmethod
+    def get_text_attribute_name(resource_attribute):
+        return resource_attribute.text_attribute_type.name
 
-    attributes = ResourceAttributeSerializer(many=True)
 
+class ResourceSerializer(serializers.ModelSerializer):
     class Meta:
         model = Resource
-        fields = ["id", "name", "service_catalog_instance", "attributes"]
+        fields = ["id", "name", "service_catalog_instance", "attributes", "text_attributes"]
 
+    attributes = ResourceAttributeSerializer(many=True)
+    text_attributes = ResourceTextAttributeSerializer(many=True)
 
-class ResourceGroupSerializer(serializers.ModelSerializer):
 
+class ResourceGroupSerializer(serializers.ModelSerializer):
     resources = ResourceSerializer(many=True, read_only=True)
 
     class Meta:
@@ -58,10 +74,25 @@ def validate_name(self, value):
                                               f"group '{resource_group.name}'")
 
 
-class ResourceCreateSerializer(serializers.Serializer):
+class TextAttributeCreateSerializer(serializers.Serializer):
+    name = serializers.CharField(max_length=100)
+    value = serializers.CharField(max_length=500)
+
+    def validate_name(self, value):
+        """Chek that this name is one the the text attribute"""
+        resource_group = self.context.get('resource_group')
+        try:
+            ResourceGroupTextAttributeDefinition.objects.get(name=value, resource_group_definition=resource_group)
+            return value
+        except ResourceGroupTextAttributeDefinition.DoesNotExist:
+            raise serializers.ValidationError(f"'{value}' is not a valid text attribute of the resource "
+                                              f"group '{resource_group.name}'")
+
 
+class ResourceCreateSerializer(serializers.Serializer):
     name = serializers.CharField(max_length=100)
     attributes = AttributeCreateSerializer(many=True)
+    text_attributes = TextAttributeCreateSerializer(many=True)
     service_catalog_instance = PrimaryKeyRelatedField(queryset=Instance.objects.all(),
                                                       allow_null=True)
 
@@ -75,6 +106,16 @@ def validate_attributes(self, attributes):
                 raise serializers.ValidationError(f"Duplicate attribute '{t[0][1]}'")
         return attributes
 
+    def validate_text_attributes(self, text_attributes):
+        seen = set()
+        for text_attribute in text_attributes:
+            t = tuple(text_attribute.items())
+            if t[0][1] not in seen:
+                seen.add(t[0][1])
+            else:
+                raise serializers.ValidationError(f"Duplicate text attribute '{t[0][1]}'")
+        return text_attributes
+
     def validate_name(self, value):
         resource_group = self.context.get('resource_group')
         try:
@@ -98,4 +139,11 @@ def create(self, validated_data):
             ResourceAttribute.objects.create(value=attribute.pop('value'),
                                              resource=new_resource,
                                              attribute_type=attribute_type)
+        text_attributes = validated_data.pop('text_attributes')
+        for text_attribute in text_attributes:
+            text_attribute_type = ResourceGroupTextAttributeDefinition.objects.get(name=text_attribute.pop('name'),
+                                                                                   resource_group_definition=resource_group)
+            ResourceTextAttribute.objects.create(value=text_attribute.pop('value'),
+                                                 resource=new_resource,
+                                                 text_attribute_type=text_attribute_type)
         return new_resource