[Module Sync] Log state changes after persistence

Currently, module sync will output messages such as:
  "cm-handle-1 is now in READY state"
before the state change is persisted to the DB. If an exception
occurs, the new state may not be persisted, which makes debugging
hard due to misleading log entries. This commit moves the logging to
the LCM state handler immediately after the change is persisted.

- Move logging of state changes to LcmEventsCmHandleStateHandler.
- Remove unused code in LcmEventsCmHandleStateHandler.
- Add tests of state change logging.
- Update the main test showing the bug to instead show expected
  behaviour, but disable test for now using @Ignore.

Issue-ID: CPS-2474
Signed-off-by: danielhanrahan <daniel.hanrahan@est.tech>
Change-Id: I58646af6df95e07e69ca525744713a7c01c25e41

2 files changed, 40 insertions, 3 deletions

diff --git a/docs/api/swagger/ncmp/openapi-inventory.yaml b/docs/api/swagger/ncmp/openapi-inventory.yaml
index a2c7af6fda..8552ad53e3 100644
--- a/docs/api/swagger/ncmp/openapi-inventory.yaml
+++ b/docs/api/swagger/ncmp/openapi-inventory.yaml
@@ -131,9 +131,19 @@ paths:
       - network-cm-proxy-inventory
   /v1/ch/searches:
     post:
-      description: "Query and get CMHandleIds for additional properties, public properties\
-        \ and registered DMI plugin (DMI plugin, DMI data plugin, DMI model plugin)."
+      description: "Query and get CMHandle references for additional properties, public\
+        \ properties and registered DMI plugin (DMI plugin, DMI data plugin, DMI model\
+        \ plugin)."
       operationId: searchCmHandleIds
+      parameters:
+      - description: Boolean parameter to determine if returned value(s) will be cmHandle
+          Ids or Alternate Ids for a given query
+        in: query
+        name: outputAlternateId
+        required: false
+        schema:
+          default: false
+          type: boolean
       requestBody:
         content:
           application/json:
@@ -182,6 +192,15 @@ components:
       schema:
         example: my-dmi-plugin
         type: string
+    outputAlternateIdOptionInQuery:
+      description: Boolean parameter to determine if returned value(s) will be cmHandle
+        Ids or Alternate Ids for a given query
+      in: query
+      name: outputAlternateId
+      required: false
+      schema:
+        default: false
+        type: boolean
   responses:
     NoContent:
       content: {}
diff --git a/docs/api/swagger/ncmp/openapi.yaml b/docs/api/swagger/ncmp/openapi.yaml
index f93395a6db..aa732c8566 100644
--- a/docs/api/swagger/ncmp/openapi.yaml
+++ b/docs/api/swagger/ncmp/openapi.yaml
@@ -1129,7 +1129,7 @@ paths:
       - network-cm-proxy
   /v1/ch/id-searches:
     post:
-      description: Execute cm handle query search and return a list of cm handle ids.
+      description: Execute cm handle query search and return a list of cm handle references.
         Any number of conditions can be applied. To be included in the result a cm-handle
         must fulfill ALL the conditions. An empty collection will be returned in the
         case that the cm handle does not match a condition. For more on cm handle
@@ -1140,6 +1140,15 @@ paths:
         Path Read the Docs</a>. The cm handle ancestor is automatically returned for
         this query.
       operationId: searchCmHandleIds
+      parameters:
+      - description: Boolean parameter to determine if returned value(s) will be cmHandle
+          Ids or Alternate Ids for a given query
+        in: query
+        name: outputAlternateId
+        required: false
+        schema:
+          default: false
+          type: boolean
       requestBody:
         content:
           application/json:
@@ -1608,6 +1617,15 @@ components:
       schema:
         example: 2024-01-22
         type: string
+    outputAlternateIdOptionInQuery:
+      description: Boolean parameter to determine if returned value(s) will be cmHandle
+        Ids or Alternate Ids for a given query
+      in: query
+      name: outputAlternateId
+      required: false
+      schema:
+        default: false
+        type: boolean
     dataSyncEnabled:
       description: Is used to enable or disable the data synchronization flag
       in: query