Dp 3047 present additional metadata items

.pre-commit-config.yaml

@@ -11,17 +11,30 @@ repos:
         exclude: tf$|j2$
 
   - repo: https://github.com/psf/black
-    rev: 23.11.0
+    rev: 23.12.1
     hooks:
       - id: black
         name: black formatting
         # args: [--config=./pyproject.toml]
 
   - repo: https://github.com/PyCQA/flake8
-    rev: 6.1.0
+    rev: 7.0.0
     hooks:
       - id: flake8
         name: flake8 lint
+        args: [
+          '--ignore=E203,E266,W503,F403',
+          '--exclude=".git, .mypy_cache, .pytest_cache, build, dist"',
+          '--max-line-length=89',
+          '--max-complexity=18',
+          '--select="B,C,E,F,W,T4,B9"'
+        ]
+        additional_dependencies:
+          - flake8-broken-line
+          - flake8-bugbear
+          - flake8-comprehensions
+          - flake8-debugger
+          - flake8-string-format
 
   - repo: https://github.com/Yelp/detect-secrets
     rev: v1.4.0
@@ -31,7 +44,14 @@ repos:
         exclude: package.lock.json
 
   - repo: https://github.com/pycqa/isort
-    rev: 5.12.0
+    rev: 5.13.2
     hooks:
       - id: isort
         name: isort (python)
+        additional_dependencies: ["toml"]
+
+  - repo: https://github.com/floatingpurr/sync_with_poetry
+    rev: "1.1.0"
+    hooks:
+      - id: sync_with_poetry
+        args: []

.secrets.baseline

@@ -0,0 +1,122 @@
+{
+  "version": "1.4.0",
+  "plugins_used": [
+    {
+      "name": "ArtifactoryDetector"
+    },
+    {
+      "name": "AWSKeyDetector"
+    },
+    {
+      "name": "AzureStorageKeyDetector"
+    },
+    {
+      "name": "Base64HighEntropyString",
+      "limit": 4.5
+    },
+    {
+      "name": "BasicAuthDetector"
+    },
+    {
+      "name": "CloudantDetector"
+    },
+    {
+      "name": "DiscordBotTokenDetector"
+    },
+    {
+      "name": "GitHubTokenDetector"
+    },
+    {
+      "name": "HexHighEntropyString",
+      "limit": 3.0
+    },
+    {
+      "name": "IbmCloudIamDetector"
+    },
+    {
+      "name": "IbmCosHmacDetector"
+    },
+    {
+      "name": "JwtTokenDetector"
+    },
+    {
+      "name": "KeywordDetector",
+      "keyword_exclude": ""
+    },
+    {
+      "name": "MailchimpDetector"
+    },
+    {
+      "name": "NpmDetector"
+    },
+    {
+      "name": "PrivateKeyDetector"
+    },
+    {
+      "name": "SendGridDetector"
+    },
+    {
+      "name": "SlackDetector"
+    },
+    {
+      "name": "SoftlayerDetector"
+    },
+    {
+      "name": "SquareOAuthDetector"
+    },
+    {
+      "name": "StripeDetector"
+    },
+    {
+      "name": "TwilioKeyDetector"
+    }
+  ],
+  "filters_used": [
+    {
+      "path": "detect_secrets.filters.allowlist.is_line_allowlisted"
+    },
+    {
+      "path": "detect_secrets.filters.common.is_ignored_due_to_verification_policies",
+      "min_level": 2
+    },
+    {
+      "path": "detect_secrets.filters.heuristic.is_indirect_reference"
+    },
+    {
+      "path": "detect_secrets.filters.heuristic.is_likely_id_string"
+    },
+    {
+      "path": "detect_secrets.filters.heuristic.is_lock_file"
+    },
+    {
+      "path": "detect_secrets.filters.heuristic.is_not_alphanumeric_string"
+    },
+    {
+      "path": "detect_secrets.filters.heuristic.is_potential_uuid"
+    },
+    {
+      "path": "detect_secrets.filters.heuristic.is_prefixed_with_dollar_sign"
+    },
+    {
+      "path": "detect_secrets.filters.heuristic.is_sequential_string"
+    },
+    {
+      "path": "detect_secrets.filters.heuristic.is_swagger_file"
+    },
+    {
+      "path": "detect_secrets.filters.heuristic.is_templated_secret"
+    }
+  ],
+  "results": {
+    "templates/base/base.html": [
+      {
+        "type": "Base64 High Entropy String",
+        "filename": "templates/base/base.html",
+        "hashed_secret": "f6538b22f89b1e2b05570de751f2932c6bca9969",
+        "is_verified": false,
+        "line_number": 40
+      }
+    ]
+  },
+  "generated_at": "2024-02-21T10:23:47Z"
+}

README.md

@@ -4,8 +4,8 @@ You will need npm (for javascript dependencies) and poetry (for python dependenc
 
 1. Run `poetry install` to install python dependencies
 2. Copy `.env.example` to `.env`.
-3. You wil need to obtain an access token from Datahub catalogue and populate the `CATALOGUE_TOKEN` var in .env to be able to retrieve search data.
-   https://datahub.apps-tools.development.data-platform.service.justice.gov.uk/settings/tokens
+3. You wil need to obtain an access token from Datahub catalogue and populate the
+`CATALOGUE_TOKEN` var in .env to be able to retrieve search data.
 4. Run `poetry run python manage.py runserver`
 
 Run `npm install` and then `npm run sass` to compile the stylesheets.
@@ -16,6 +16,16 @@ Run `npm install` and then `npm run sass` to compile the stylesheets.
 
 ![Screenshot of the service showing the search page](image.png)
 
+## Contributing
+
+Run `pre-commit install` from inside the poetry environment to set up pre commit hooks.
+
+- Linting and formatting handled by `black`, `flake8`, `pre-commit`, and `isort`
+  - `isort` is configured in `pyproject.toml`
+- `detect-secrets` is used to prevent leakage of secrets
+- `sync_with_poetry` ensures the versions of the modules in the pre-commit specification
+  are kept in line with those in the `pyproject.toml` config.
+
 ## Testing
 
 - Unit tests: `pytest -m 'not slow'`

core/__init__.py

@@ -1,2 +1,2 @@
 # -*- coding: utf-8 -*-
-from .settings import *
+from .settings import *  # noqa: F401

core/settings.py

@@ -67,7 +67,7 @@
 
 AUTH_PASSWORD_VALIDATORS = [
     {
-        "NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator",
+        "NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator",  # noqa: E501
     },
     {
         "NAME": "django.contrib.auth.password_validation.MinimumLengthValidator",
@@ -86,10 +86,8 @@
 
 LANGUAGE_CODE = "en-gb"
 
-TIME_ZONE = "UTC"
-
-USE_I18N = True
-
+TIME_ZONE = "Europe/London"
+USE_I18N = False
 USE_TZ = True
 
 
@@ -113,8 +111,7 @@
     "django.contrib.staticfiles.finders.AppDirectoriesFinder",
 )
 
-SAMPLE_SEARCH_RESULTS_FILENAME = BASE_DIR / \
-    "sample_data/sample_search_page.yaml"
+SAMPLE_SEARCH_RESULTS_FILENAME = BASE_DIR / "sample_data/sample_search_page.yaml"
 
 with open(SAMPLE_SEARCH_RESULTS_FILENAME) as f:
     SAMPLE_SEARCH_RESULTS = yaml.safe_load(f)

core/urls.py

@@ -14,6 +14,7 @@
     1. Import the include() function: from django.urls import include, path
     2. Add a URL to urlpatterns:  path('blog/', include('blog.urls'))
 """
+
 from django.contrib import admin
 from django.urls import include, path
 

home/forms/search.py

@@ -4,12 +4,13 @@
 from django import forms
 
 
-def get_domain_choices():
+def get_domain_choices() -> list[tuple[str, str]]:
     """Make API call to obtain domain choices"""
     # TODO: pull in the domains from the catalogue client
     # facets = client.search_facets()
-    # domain_list = facets.options("domains")
+    # domain_list = facets.options("domain")
     return [
+        ("", "All Domains"),
         ("urn:li:domain:HMCTS", "HMCTS"),
         ("urn:li:domain:HMPPS", "HMPPS"),
         ("urn:li:domain:HQ", "HQ"),
@@ -69,6 +70,19 @@ def get_sort_choices():
     ]
 
 
+def get_classification_choices():
+    return [
+        ("OFFICIAL", "Official"),
+        ("OFFICIAL-SENSITIVE", "Official-Sensitive"),
+        ("SECRET", "Secret"),
+        ("TOP-SECRET", "Top-Secret"),
+    ]
+
+
+def get_where_to_access_choices():
+    return [("analytical_platform", "Analytical Platform")]
+
+
 class SearchForm(forms.Form):
     """Django form to represent data product search page inputs"""
 
@@ -78,9 +92,27 @@ class SearchForm(forms.Form):
         required=False,
         widget=forms.TextInput(attrs={"class": "govuk-input search-input"}),
     )
-    domains = forms.MultipleChoiceField(
+    domain = forms.ChoiceField(
         choices=get_domain_choices,
         required=False,
+        widget=forms.Select(
+            attrs={
+                "form": "searchform",
+                "class": "govuk-select",
+                "aria-label": "domain",
+            }
+        ),
+    )
+    classifications = forms.MultipleChoiceField(
+        choices=get_classification_choices,
+        required=False,
+        widget=forms.CheckboxSelectMultiple(
+            attrs={"class": "govuk-checkboxes__input", "form": "searchform"}
+        ),
+    )
+    where_to_access = forms.MultipleChoiceField(
+        choices=get_where_to_access_choices,
+        required=False,
         widget=forms.CheckboxSelectMultiple(
             attrs={"class": "govuk-checkboxes__input", "form": "searchform"}
         ),
@@ -103,13 +135,13 @@ def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
         self.initial["sort"] = "relevance"
 
-    def encode_without_filter(self, filter_to_remove):
+    def encode_without_filter(self, filter_name: str, filter_value: str):
         """Preformat hrefs to drop individual filters"""
         # Deepcopy the cleaned data dict to avoid modifying it inplace
         query_params = deepcopy(self.cleaned_data)
-
-        query_params["domains"].remove(filter_to_remove)
-        if len(query_params["domains"]) == 0:
-            query_params.pop("domains")
-
+        value = query_params.get(filter_name)
+        if isinstance(value, list) and filter_value in value:
+            value.remove(filter_value)
+        elif isinstance(value, str) and filter_value == value:
+            query_params.pop(filter_name)
         return f"?{urlencode(query_params, doseq=True)}"

home/helper.py

@@ -8,5 +8,5 @@ def filter_seleted_domains(domain_list, domains):
 
 def get_domain_list(client):
     facets = client.search_facets()
-    domain_list = facets.options("domains")
+    domain_list = facets.options("domain")
     return domain_list

home/service/details.py

@@ -10,8 +10,7 @@ def __init__(self, urn: str):
         self.client = self._get_catalogue_client()
 
         filter_value = [MultiSelectFilter("urn", [urn])]
-        search_results = self.client.search(
-            query="", page=None, filters=filter_value)
+        search_results = self.client.search(query="", page=None, filters=filter_value)
 
         if not search_results.page_results:
             raise ObjectDoesNotExist(urn)