[WIP] Improving component comparison to do side-by-side comparisons

.github/ISSUE_TEMPLATE/bug_report.md

@@ -7,42 +7,37 @@ assignees: ''
 
 ---
 
-**Describe the bug as a Story**
+## Bug
 A clear and concise description of what the bug is.
 
-**To Reproduce**
+## To Reproduce
 Steps to reproduce the behavior:
 1. Go to '...'
 2. Click on '....'
 3. Scroll down to '....'
 4. See error
 
-**Expected behavior**
-A clear and concise description of what you expected to happen.
-
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
-
-**Desktop (please complete the following information):**
+Desktop (please complete the following information):
  - OS: [e.g. iOS]
  - Browser [e.g. chrome, safari]
  - Version [e.g. 22]
  - Virtual Machine?
  - Screen size
 
+## Expected behavior
+A clear and concise description of what you expected to happen.
+
+## Screenshots
+If applicable, add screenshots to help explain your problem.
+
 
 ## Developer hints
 
-Look at this file, template, etc
+- hint
 
 ## Acceptance criteria 
 
-  GIVEN this issue ...
-  WHEN I do this ...
-  THEN this happens ...
-
+- criteria
 
-**Additional context**
-Add any other context about the problem here.
 
-### Links referenced in issue
+## Reference

.github/ISSUE_TEMPLATE/feature_request.md

@@ -7,14 +7,17 @@ assignees: ''
 
 ---
 
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+## Stories
 
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
+As a user, I want this so that I can that.
+
+## Discussion
+
+- item
+
+## Visuals
+
+
+## Acceptance Criteria
 
-**Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
 
-**Additional context**
-Add any other context or screenshots about the feature request here.

CHANGELOG.md

@@ -1,12 +1,54 @@
 GovReady-Q Release Notes
 ========================
 
-v0.9.11.7-dev (October xx, 2021)
---------------------------------
+
+v0.9.11.11-dev (December xx, 2021)
+---------------------------------
+
+**UI changes**
+
+* Simplify task progress history. Only display questions of current module. Only colorize to glyphicons.
+* Enable adding component control statement from System selected component.
+
+**Bug fixes**
+
+* Stop scrubching of progress-project-area-wrapper on question page.
+
+
+v0.9.11.10-dev (December xx, 2021)
+---------------------------------
+
+Introuduce new authoring tool. Remove authoring tool modal from task question page.
+
+**Feature changes**
+
+* Enabling batch viewing of questions for easier questionnaire authoring.
+* Enable editing of artifacts.
+* Enabling cloning entire templates in template library.
+
+**Developer changes**
+
+* Add Django `nlp` app to system to support Natural Language Processing of SSPs and statements.
+* Include spaCy libraries as part of build.
+* Include initial, simplified candidate entity recognition script.
+* Remove full text search of statements from component library search because it was slow and returned to many results.
+* Add serializers for Modules and ModuleQuestions.
+* Refactor siteapp.views.project and templates/project.html to remove vestigial column vs row layout code and previous authoring tools.
+* Remove authoring tool modal from task question page.
 
 **UI changes**
 
 * Use left side vertical React navigation menu for project.
+* Improve toast message appearance by limiting width.
+* Improve styling of project page rollovers make module actions clearer
+* Improve styling of template library. Use bootstrap panels for each item.
+* Remove authoring tool modal from task question page.
+
+**Bug fixes**
+
+* Fix permissions to allow non-administrator to clone project templates in project template.
+* Fix crash when restoring a previous version of a statement.
+* Fix setting control baseline by proper use of `update_or_create` in `System.set_security_impact_level`.
 
 
 v0.9.11.6 (October 13, 2021)

VERSION

@@ -1 +1 @@
-v0.9.11.7-dev
+v0.9.11.11-dev

api/base/urls.py

@@ -17,6 +17,6 @@ def get_swagger_urls():
 
     return [
         url(r'^docs/swagger(?P<format>\.json|\.yaml)$', schema_view.without_ui(cache_timeout=0), name='schema-json'),
-        url(r'^docs/swagger/$', schema_view.with_ui('swagger', cache_timeout=0), name='schema-swagger-ui')
+        url(r'^docs/swagger/$', schema_view.with_ui('swagger', cache_timeout=0), name='schema-swagger-ui'),
     ]
 

api/guidedmodules/serializers/app.py

@@ -24,6 +24,9 @@ class Meta:
 
 
 class SimpleAppVersionSourceSerializer(ReadOnlySerializer):
+    catalog_metadata = serializers.JSONField()
+    asset_paths = serializers.JSONField()
+
     class Meta:
         model = AppVersion
         fields = ['appname', 'system_app', 'catalog_metadata', 'version_number', 'version_name', 'input_paths',

api/guidedmodules/serializers/modules.py

@@ -1,7 +1,7 @@
 from rest_framework import serializers
 
-from api.base.serializers.types import ReadOnlySerializer
-from api.guidedmodules.serializers.app import DetailedAppVersionSerializer, SimpleAppSourceSerializer
+from api.base.serializers.types import ReadOnlySerializer, WriteOnlySerializer
+from api.guidedmodules.serializers.app import DetailedAppVersionSerializer, SimpleAppSourceSerializer, SimpleAppVersionSourceSerializer
 from guidedmodules.models import Module, ModuleAsset, ModuleQuestion
 from rest_framework_recursive.fields import RecursiveField
 
@@ -16,7 +16,6 @@ class Meta:
         model = Module
         fields = ['module_name', 'spec']
 
-
 class DetailedModuleSerializer(SimpleModuleSerializer):
     source = SimpleAppSourceSerializer()
     app = DetailedAppVersionSerializer()
@@ -42,15 +41,45 @@ class Meta:
 
 
 class SimpleModuleQuestionSerializer(ReadOnlySerializer):
+    spec = serializers.JSONField()
+
     class Meta:
         model = ModuleQuestion
         fields = ['key', 'definition_order', 'spec']
 
 
 class DetailedModuleQuestionSerializer(SimpleModuleQuestionSerializer):
-    module = DetailedModuleSerializer()
+
+    class Meta:
+        model = ModuleQuestion
+        fields = SimpleModuleQuestionSerializer.Meta.fields
+
+
+class ModuleQuestionListSerializer(SimpleModuleQuestionSerializer):
     answer_type_module = DetailedModuleSerializer()
 
     class Meta:
         model = ModuleQuestion
-        fields = SimpleModuleQuestionSerializer.Meta.fields + ['module', 'answer_type_module']
+        fields = SimpleModuleQuestionSerializer.Meta.fields
+
+class ModuleReadSerializer(ReadOnlySerializer):
+    spec = serializers.JSONField()
+    app = SimpleAppVersionSourceSerializer()
+    questions = SimpleModuleQuestionSerializer(many=True)
+
+    class Meta:
+        model = Module
+        fields = ['module_name', 'spec', 'app', 'questions']
+
+class CreateModuleQuestionSerializer(WriteOnlySerializer):
+    spec = serializers.JSONField()
+    key = serializers.CharField()
+    definition_order = serializers.IntegerField()
+
+    # module_id = serializers.PrimaryKeyRelatedField(source='module', allow_null=False, queryset=Module.objects)
+
+    class Meta:
+        model = ModuleQuestion
+        fields = ['key', 'definition_order', 'spec'
+        ]
+

api/guidedmodules/urls.py

@@ -1,9 +1,18 @@
 from django.conf.urls import url
 from django.urls import include
 from rest_framework import routers
+from rest_framework_nested.routers import NestedSimpleRouter
+from api.guidedmodules.views.module import ModuleViewSet
+from api.guidedmodules.views.module_questions import ModuleQuestionViewSet
+
 
 router = routers.DefaultRouter()
+router.register('modules', ModuleViewSet)
+
+module_router = NestedSimpleRouter(router, 'modules', lookup='modules')
+module_router.register('questions', ModuleQuestionViewSet, basename='module-questions')
 
 urlpatterns = [
     url(r'^', include(router.urls)),
+    url(r'^', include(module_router.urls)),
 ]

api/guidedmodules/views/module.py

@@ -0,0 +1,13 @@
+from rest_framework.decorators import action
+from rest_framework.response import Response
+
+from api.base.views.base import SerializerClasses
+from api.base.views.viewsets import ReadOnlyViewSet
+from api.guidedmodules.serializers.modules import ModuleReadSerializer
+from guidedmodules.models import Module
+
+
+class ModuleViewSet(ReadOnlyViewSet):
+    queryset = Module.objects.all()
+    serializer_classes = SerializerClasses(retrieve=ModuleReadSerializer,
+                                           list=ModuleReadSerializer)

api/guidedmodules/views/module_questions.py

@@ -0,0 +1,19 @@
+from rest_framework.decorators import action
+from rest_framework.response import Response
+
+from api.base.views.base import SerializerClasses
+from api.base.views.viewsets import ReadWriteViewSet
+from api.guidedmodules.serializers.modules import SimpleModuleQuestionSerializer, CreateModuleQuestionSerializer
+from guidedmodules.models import Module, ModuleQuestion
+
+
+class ModuleQuestionViewSet(ReadWriteViewSet):
+    NESTED_ROUTER_PKS = [{'pk': 'modules_pk', 'model_field': 'module', 'model': Module}]
+    queryset = ModuleQuestion.objects.all()
+    ordering = ('definition_order',)
+    serializer_classes = SerializerClasses(retrieve=SimpleModuleQuestionSerializer,
+                                           list=SimpleModuleQuestionSerializer,
+                                           create=CreateModuleQuestionSerializer,
+                                           update=CreateModuleQuestionSerializer,
+                                           destroy=CreateModuleQuestionSerializer)
+

controls/models.py

@@ -590,16 +590,25 @@ def remove_control(self, control_id):
     @transaction.atomic
     def set_security_sensitivity_level(self, security_sensitivity_level):
         """Assign Security Sensitivty level to system"""
-        # Get or create the security_sensitivity_level smt for system's root_element; should only have 1 statement
-        smt = Statement.objects.create(statement_type=StatementTypeEnum.SECURITY_SENSITIVITY_LEVEL.name, producer_element=self.root_element, consumer_element=self.root_element, body=security_sensitivity_level)
-        return security_sensitivity_level, smt
+        # Update or create the security_sensitivity_level smt for system's root_element; should only have 1 statement
+
+        # NOTE: Cannot us update or create because changing security_sensitivity_smt level will fail to find existing security_sensitivity_smt
+        if Statement.objects.filter(statement_type=StatementTypeEnum.SECURITY_SENSITIVITY_LEVEL.name, producer_element=self.root_element,consumer_element=self.root_element).exists():
+            security_sensitivity_smt = Statement.objects.get(statement_type=StatementTypeEnum.SECURITY_SENSITIVITY_LEVEL.name, producer_element=self.root_element,consumer_element=self.root_element)
+            security_sensitivity_smt.body = security_sensitivity_level
+            security_sensitivity_smt.save()
+        else:
+            # Set the security_sensitivity_level smt for element; should only have 1 statement
+            security_sensitivity_smt = Statement.objects.create(statement_type=StatementTypeEnum.SECURITY_SENSITIVITY_LEVEL.name, producer_element=self.root_element,consumer_element=self.root_element, body=security_sensitivity_level)
+
+        return security_sensitivity_level, security_sensitivity_smt
 
     @property
     def get_security_sensitivity_level(self):
-        """Assign Security Sensitivty level to system"""
+        """Get Security Sensitivty level to system"""
 
         # Get or create the security_sensitivity_level smt for system's root_element; should only have 1 statement
-        smt, created = Statement.objects.get_or_create(statement_type=StatementTypeEnum.SECURITY_SENSITIVITY_LEVEL.name, producer_element=self.root_element, consumer_element=self.root_element)
+        smt = Statement.objects.get(statement_type=StatementTypeEnum.SECURITY_SENSITIVITY_LEVEL.name, producer_element=self.root_element, consumer_element=self.root_element)
         security_sensitivity_level = smt.body
         return security_sensitivity_level
 
@@ -612,7 +621,7 @@ def set_security_impact_level(self, security_impact_level):
             security_objective_smt.update(body=security_impact_level)
         else:
             # Set the security_impact_level smt for element; should only have 1 statement
-            security_objective_smt, created = Statement.objects.get_or_create(statement_type=StatementTypeEnum.SECURITY_IMPACT_LEVEL.name, producer_element=self.root_element,consumer_element=self.root_element, body=security_impact_level)
+            security_objective_smt, created = Statement.objects.create(statement_type=StatementTypeEnum.SECURITY_IMPACT_LEVEL.name, producer_element=self.root_element,consumer_element=self.root_element, body=security_impact_level)
         return security_impact_level, security_objective_smt
 
     @property