S28-3556 - Create GET /audit API endpoint #858

pr00279 · 2024-12-12T09:49:02Z

JIRA ticket(s)

S28-3556

Change description

Add methods for a new GET endpoint which returns audit logs in date desc. order for SUPER_USER only

src/main/java/uk/gov/hmcts/reform/preapi/controllers/AuditController.java

src/main/java/uk/gov/hmcts/reform/preapi/services/AuditService.java

…3556

… w/ different user permissions

…ontrollerFT, rename test too, add null value test

…anges only)

hmcts-jenkins-cnp · 2024-12-18T14:15:37Z

Plan Result (stg)

⚠️ Resource Deletion will happen

This plan contains resource delete operation. Please check the plan result very carefully!

Plan: 1 to add, 5 to change, 1 to destroy.

Update
- module.apim_subscription_editvm[0].azurerm_api_management_subscription.subscription
- module.apim_subscription_portal[0].azurerm_api_management_subscription.subscription
- module.apim_subscription_powerplatform[0].azurerm_api_management_subscription.subscription
- module.apim_subscription_smoketest[0].azurerm_api_management_subscription.subscription
- module.pre-api-exception-alert[0].azurerm_resource_group_template_deployment.custom_alert[0]
Replace
- module.pre_api[0].azurerm_api_management_api.api

Change Result (Click me)

  # module.apim_subscription_editvm[0].azurerm_api_management_subscription.subscription will be updated in-place
  ~ resource "azurerm_api_management_subscription" "subscription" {
      ~ allow_tracing       = false -> true
        id                  = "/subscriptions/74dacd4f-a248-45bb-a2f0-af700dc4cf68/resourceGroups/ss-stg-network-rg/providers/Microsoft.ApiManagement/service/sds-api-mgmt-stg/subscriptions/8265f455-2bf2-4c4b-8ba3-bfd0a2f5a6b7"
        # (10 unchanged attributes hidden)
    }

  # module.apim_subscription_portal[0].azurerm_api_management_subscription.subscription will be updated in-place
  ~ resource "azurerm_api_management_subscription" "subscription" {
      ~ allow_tracing       = false -> true
        id                  = "/subscriptions/74dacd4f-a248-45bb-a2f0-af700dc4cf68/resourceGroups/ss-stg-network-rg/providers/Microsoft.ApiManagement/service/sds-api-mgmt-stg/subscriptions/500e642d-76ef-4d82-8741-bf9e9d979705"
        # (10 unchanged attributes hidden)
    }

  # module.apim_subscription_powerplatform[0].azurerm_api_management_subscription.subscription will be updated in-place
  ~ resource "azurerm_api_management_subscription" "subscription" {
      ~ allow_tracing       = false -> true
        id                  = "/subscriptions/74dacd4f-a248-45bb-a2f0-af700dc4cf68/resourceGroups/ss-stg-network-rg/providers/Microsoft.ApiManagement/service/sds-api-mgmt-stg/subscriptions/37f73c17-345b-4c67-81d5-50d582e97227"
        # (10 unchanged attributes hidden)
    }

  # module.apim_subscription_smoketest[0].azurerm_api_management_subscription.subscription will be updated in-place
  ~ resource "azurerm_api_management_subscription" "subscription" {
      ~ allow_tracing       = false -> true
        id                  = "/subscriptions/74dacd4f-a248-45bb-a2f0-af700dc4cf68/resourceGroups/ss-stg-network-rg/providers/Microsoft.ApiManagement/service/sds-api-mgmt-stg/subscriptions/da1d82f9-7187-4cb6-a6dd-b0020311f3bb"
        # (10 unchanged attributes hidden)
    }

  # module.pre-api-exception-alert[0].azurerm_resource_group_template_deployment.custom_alert[0] will be updated in-place
  ~ resource "azurerm_resource_group_template_deployment" "custom_alert" {
        id                       = "/subscriptions/74dacd4f-a248-45bb-a2f0-af700dc4cf68/resourceGroups/pre-stg/providers/Microsoft.Resources/deployments/PRE_API_exception"
        name                     = "PRE_API_exception"
        tags                     = {}
      ~ template_content         = jsonencode(
          ~ {
              ~ parameters     = {
                  ~ actionGroupName          = {
                      ~ type = "String" -> "string"
                    }
                  ~ actionGroupRg            = {
                      ~ type = "String" -> "string"
                    }
                  ~ alertDesc                = {
                      ~ type = "String" -> "string"
                    }
                  ~ alertName                = {
                      ~ type = "String" -> "string"
                    }
                  ~ appInsightsName          = {
                      ~ type = "String" -> "string"
                    }
                  ~ appInsightsQuery         = {
                      ~ type = "String" -> "string"
                    }
                  ~ commonTags               = {
                      ~ type = "String" -> "string"
                    }
                  ~ customEmailSubject       = {
                      ~ type = "String" -> "string"
                    }
                  ~ frequencyInMinutes       = {
                      ~ type         = "String" -> "string"
                        # (1 unchanged attribute hidden)
                    }
                  ~ location                 = {
                      ~ type = "String" -> "string"
                    }
                  ~ severityLevel            = {
                      ~ type         = "String" -> "string"
                        # (1 unchanged attribute hidden)
                    }
                  ~ timeWindowInMinutes      = {
                      ~ type         = "String" -> "string"
                        # (1 unchanged attribute hidden)
                    }
                  ~ triggerThreshold         = {
                      ~ type = "String" -> "string"
                    }
                  ~ triggerThresholdOperator = {
                      ~ type          = "String" -> "string"
                        # (2 unchanged attributes hidden)
                    }
                }
                # (4 unchanged attributes hidden)
            }
        )
        # (6 unchanged attributes hidden)
    }

  # module.pre_api[0].azurerm_api_management_api.api must be replaced
-/+ resource "azurerm_api_management_api" "api" {
      ~ id                    = "/subscriptions/74dacd4f-a248-45bb-a2f0-af700dc4cf68/resourceGroups/ss-stg-network-rg/providers/Microsoft.ApiManagement/service/sds-api-mgmt-stg/apis/pre-api;rev=93" -> (known after apply)
      ~ is_current            = true -> (known after apply)
      ~ is_online             = false -> (known after apply)
        name                  = "pre-api"
      ~ revision              = "93" -> "94" # forces replacement
      + version               = (known after apply)
      + version_set_id        = (known after apply)
        # (12 unchanged attributes hidden)

      ~ subscription_key_parameter_names (known after apply)
      - subscription_key_parameter_names {
          - header = "Ocp-Apim-Subscription-Key" -> null
          - query  = "subscription-key" -> null
        }

        # (1 unchanged block hidden)
    }

Plan: 1 to add, 5 to change, 1 to destroy.

hmcts-jenkins-cnp · 2024-12-18T14:16:10Z

Plan Result (prod)

⚠️ Resource Deletion will happen

This plan contains resource delete operation. Please check the plan result very carefully!

Plan: 1 to add, 2 to change, 1 to destroy.

Update
- module.pre-api-exception-alert[0].azurerm_resource_group_template_deployment.custom_alert[0]
- module.pre-api-liveness-alert[0].azurerm_resource_group_template_deployment.custom_alert[0]
Replace
- module.pre_api[0].azurerm_api_management_api.api

Change Result (Click me)

  # module.pre-api-exception-alert[0].azurerm_resource_group_template_deployment.custom_alert[0] will be updated in-place
  ~ resource "azurerm_resource_group_template_deployment" "custom_alert" {
        id                       = "/subscriptions/5ca62022-6aa2-4cee-aaa7-e7536c8d566c/resourceGroups/pre-prod/providers/Microsoft.Resources/deployments/PRE_API_exception"
        name                     = "PRE_API_exception"
        tags                     = {}
      ~ template_content         = jsonencode(
          ~ {
              ~ parameters     = {
                  ~ actionGroupName          = {
                      ~ type = "String" -> "string"
                    }
                  ~ actionGroupRg            = {
                      ~ type = "String" -> "string"
                    }
                  ~ alertDesc                = {
                      ~ type = "String" -> "string"
                    }
                  ~ alertName                = {
                      ~ type = "String" -> "string"
                    }
                  ~ appInsightsName          = {
                      ~ type = "String" -> "string"
                    }
                  ~ appInsightsQuery         = {
                      ~ type = "String" -> "string"
                    }
                  ~ commonTags               = {
                      ~ type = "String" -> "string"
                    }
                  ~ customEmailSubject       = {
                      ~ type = "String" -> "string"
                    }
                  ~ frequencyInMinutes       = {
                      ~ type         = "String" -> "string"
                        # (1 unchanged attribute hidden)
                    }
                  ~ location                 = {
                      ~ type = "String" -> "string"
                    }
                  ~ severityLevel            = {
                      ~ type         = "String" -> "string"
                        # (1 unchanged attribute hidden)
                    }
                  ~ timeWindowInMinutes      = {
                      ~ type         = "String" -> "string"
                        # (1 unchanged attribute hidden)
                    }
                  ~ triggerThreshold         = {
                      ~ type = "String" -> "string"
                    }
                  ~ triggerThresholdOperator = {
                      ~ type          = "String" -> "string"
                        # (2 unchanged attributes hidden)
                    }
                }
                # (4 unchanged attributes hidden)
            }
        )
        # (6 unchanged attributes hidden)
    }

  # module.pre-api-liveness-alert[0].azurerm_resource_group_template_deployment.custom_alert[0] will be updated in-place
  ~ resource "azurerm_resource_group_template_deployment" "custom_alert" {
        id                       = "/subscriptions/5ca62022-6aa2-4cee-aaa7-e7536c8d566c/resourceGroups/pre-prod/providers/Microsoft.Resources/deployments/PRE_API_liveness"
        name                     = "PRE_API_liveness"
        tags                     = {}
      ~ template_content         = jsonencode(
          ~ {
              ~ parameters     = {
                  ~ actionGroupName          = {
                      ~ type = "String" -> "string"
                    }
                  ~ actionGroupRg            = {
                      ~ type = "String" -> "string"
                    }
                  ~ alertDesc                = {
                      ~ type = "String" -> "string"
                    }
                  ~ alertName                = {
                      ~ type = "String" -> "string"
                    }
                  ~ appInsightsName          = {
                      ~ type = "String" -> "string"
                    }
                  ~ appInsightsQuery         = {
                      ~ type = "String" -> "string"
                    }
                  ~ commonTags               = {
                      ~ type = "String" -> "string"
                    }
                  ~ customEmailSubject       = {
                      ~ type = "String" -> "string"
                    }
                  ~ frequencyInMinutes       = {
                      ~ type         = "String" -> "string"
                        # (1 unchanged attribute hidden)
                    }
                  ~ location                 = {
                      ~ type = "String" -> "string"
                    }
                  ~ severityLevel            = {
                      ~ type         = "String" -> "string"
                        # (1 unchanged attribute hidden)
                    }
                  ~ timeWindowInMinutes      = {
                      ~ type         = "String" -> "string"
                        # (1 unchanged attribute hidden)
                    }
                  ~ triggerThreshold         = {
                      ~ type = "String" -> "string"
                    }
                  ~ triggerThresholdOperator = {
                      ~ type          = "String" -> "string"
                        # (2 unchanged attributes hidden)
                    }
                }
                # (4 unchanged attributes hidden)
            }
        )
        # (6 unchanged attributes hidden)
    }

  # module.pre_api[0].azurerm_api_management_api.api must be replaced
-/+ resource "azurerm_api_management_api" "api" {
      ~ id                    = "/subscriptions/5ca62022-6aa2-4cee-aaa7-e7536c8d566c/resourceGroups/ss-prod-network-rg/providers/Microsoft.ApiManagement/service/sds-api-mgmt-prod/apis/pre-api;rev=93" -> (known after apply)
      ~ is_current            = true -> (known after apply)
      ~ is_online             = false -> (known after apply)
        name                  = "pre-api"
      ~ revision              = "93" -> "94" # forces replacement
      + version               = (known after apply)
      + version_set_id        = (known after apply)
        # (12 unchanged attributes hidden)

      ~ subscription_key_parameter_names (known after apply)
      - subscription_key_parameter_names {
          - header = "Ocp-Apim-Subscription-Key" -> null
          - query  = "subscription-key" -> null
        }

        # (1 unchanged block hidden)
    }

Plan: 1 to add, 2 to change, 1 to destroy.

…e and size from swagger

…3556

…rename local auditEntity vars in AuditServiceTest, use hasSize instead)

lucas-phillips28

Looks good to me. I've added the enable_helm_keep tag so QA can test before merging :)

S28-3556: add method & FT for audit log display

c3261bc

pr00279 requested a review from a team as a code owner December 12, 2024 09:49

lucas-phillips28 reviewed Dec 12, 2024

View reviewed changes

src/main/java/uk/gov/hmcts/reform/preapi/controllers/AuditController.java Outdated Show resolved Hide resolved

lucas-phillips28 reviewed Dec 12, 2024

View reviewed changes

src/main/java/uk/gov/hmcts/reform/preapi/services/AuditService.java Outdated Show resolved Hide resolved

Phoebe Revolta and others added 26 commits December 13, 2024 10:02

S28-3556: correct audit log query

b4a5d0e

Merge branch 'master' into S28-3556

d274b3e

Update Swagger v2 Spec Bump APIm revision to 94

2f11ef1

Merge branch 'master' into S28-3556

c306361

S28-3556: resolve merge conflict

14bb369

S28-3556: create AuditDTO.java

d42fab0

Update Swagger v2 Spec

bad3267

S28-3556: add test for AuditService

32809e7

Merge branch 'S28-3556' of https://github.com/hmcts/pre-api into S28-…

4b45391

…3556

S28-3556: fix auditServiceTest

38de486

S28-3556: remove unused import

8aab630

disable auth ONLY for audit PUT endpoint

ca67746

Merge branch 'master' into S28-3556

bab07e1

S28-3556: amend AuditControllerFT to return audit logs

1dd69e8

Merge branch 'master' into S28-3556

5eeac9a

S28-3556: fix AuditControllerFT

3837221

Merge branch 'master' into S28-3556

85c875a

S28-3556: amend getAuditLogsSortBy() FT description

99e445f

S28-3556: add parameterized test for AuditController 403 GET endpoint…

8aac6c4

… w/ different user permissions

Merge branch 'master' into S28-3556

6c5d63a

S28-3556: add test for null value in AuditControllerFT

51fd0c2

Merge branch 'master' into S28-3556

d598a61

S28-3556: reorder conditional in unauthorised requests test in AuditC…

9973022

…ontrollerFT, rename test too, add null value test

S28-3556: remove unused package in AuditControllerFT

4d78c5e

Merge branch 'master' into S28-3556

08b4bd9

S28-3556: resolve checksum issues in AuditControllerFT (whitespace ch…

7753575

…anges only)

Phoebe Revolta added 2 commits December 18, 2024 13:50

S28-3556: add AuditDTO test

180ba96

S28-3556: add test to AuditControllerTest

a62e5c0

hmcts-jenkins-cnp bot added the stg/destroy label Dec 18, 2024

hmcts-jenkins-cnp bot added the prod/destroy label Dec 18, 2024

hmcts-jenkins-cnp bot deployed to preview December 18, 2024 14:16 View deployment

hmcts-jenkins-cnp bot added ns:pre prd:pre rel:pre-api-pr-858 labels Dec 18, 2024

Phoebe Revolta added 2 commits December 19, 2024 09:32

S28-3556: add test for pageable exception in AuditControllerTest

716fdf1

Merge branch 'master' into S28-3556

dfcceb1

hmcts-jenkins-cnp bot deployed to preview December 19, 2024 09:40 View deployment

Phoebe Revolta and others added 7 commits January 6, 2025 09:29

Merge branch 'master' into S28-3556

6bb9014

Merge branch 'master' into S28-3556

8372338

Merge branch 'master' into S28-3556

35fff0a

S28-3556: add params in AuditController searchAuditLogs to modify pag…

458e3b5

…e and size from swagger

Update Swagger v2 Spec

a37d908

S28-3556: resolve checkstyle error w/ import ordering in AuditController

1495f3a

Merge branch 'S28-3556' of https://github.com/hmcts/pre-api into S28-…

ebf4467

…3556

hmcts-jenkins-cnp bot deployed to preview January 7, 2025 12:04 View deployment

S28-3556: address sonarcloud issues (remove AuditDTOTest publicness, …

5e244ee

…rename local auditEntity vars in AuditServiceTest, use hasSize instead)

hmcts-jenkins-cnp bot deployed to preview January 7, 2025 12:27 View deployment

lucas-phillips28 added the enable_keep_helm label Jan 7, 2025

lucas-phillips28 approved these changes Jan 7, 2025

View reviewed changes

pr00279 closed this Jan 7, 2025

pr00279 deleted the S28-3556 branch January 7, 2025 14:21

pr00279 restored the S28-3556 branch January 7, 2025 14:22

hmcts-jenkins-cnp bot deployed to preview January 7, 2025 14:31 View deployment

hmcts-jenkins-cnp bot deployed to preview January 8, 2025 14:53 View deployment

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

S28-3556 - Create GET /audit API endpoint #858

S28-3556 - Create GET /audit API endpoint #858

pr00279 commented Dec 12, 2024 •

edited

Loading

hmcts-jenkins-cnp bot commented Dec 18, 2024

hmcts-jenkins-cnp bot commented Dec 18, 2024

lucas-phillips28 left a comment •

edited

Loading

S28-3556 - Create GET /audit API endpoint #858

S28-3556 - Create GET /audit API endpoint #858

Conversation

pr00279 commented Dec 12, 2024 • edited Loading

JIRA ticket(s)

Change description

hmcts-jenkins-cnp bot commented Dec 18, 2024

Plan Result (stg)

⚠️ Resource Deletion will happen

hmcts-jenkins-cnp bot commented Dec 18, 2024

Plan Result (prod)

⚠️ Resource Deletion will happen

lucas-phillips28 left a comment • edited Loading

Choose a reason for hiding this comment

pr00279 commented Dec 12, 2024 •

edited

Loading

lucas-phillips28 left a comment •

edited

Loading