feat: Add API getDebtPositionByIUV [PAGOPA-1744]

.github/workflows/integration_test.yml

@@ -57,15 +57,15 @@ jobs:
     needs: [ integration_test ]
     runs-on: ubuntu-latest
     name: Notify
-    if: always()
+    if: ${{ always() && inputs.environment == 'uat' }}
     steps:
       - name: Report Status
         if: always()
         uses: ravsamhq/notify-slack-action@v2
         with:
           status: ${{ needs.integration_test.result }}
           token: ${{ secrets.GITHUB_TOKEN }}
-          notify_when: 'failure,skipped'
+          notify_when: 'failure'
           notification_title: '{workflow} has {status_message}'
           message_format: '{emoji} <{workflow_url}|{workflow}> {status_message} in <{repo_url}|{repo}>'
           footer: 'Linked to Repo <{repo_url}|{repo}>'

helm/Chart.yaml

@@ -2,8 +2,8 @@ apiVersion: v2
 name: pagopa-gpd-core
 description: micro-service to manage Creditor Institution debtor positions
 type: application
-version: 0.124.0
-appVersion: 0.11.27
+version: 0.125.0
+appVersion: 0.11.27-1-PAGOPA-1744-getDebtPositionByIUV
 dependencies:
   - name: microservice-chart
     version: 2.4.0

helm/values-dev.yaml

@@ -5,7 +5,7 @@ microservice-chart:
   image:
     repository: ghcr.io/pagopa/pagopa-debt-position
     tag: "0.11.2-1-PAGOPA-1530-upsert"
-    tag: "0.11.27"
+    tag: "0.11.27-1-PAGOPA-1744-getDebtPositionByIUV"
     pullPolicy: Always
   livenessProbe:
     httpGet:

helm/values-prod.yaml

@@ -4,7 +4,7 @@ microservice-chart:
   fullnameOverride: ""
   image:
     repository: ghcr.io/pagopa/pagopa-debt-position
-    tag: "0.11.27"
+    tag: "0.11.27-1-PAGOPA-1744-getDebtPositionByIUV"
     pullPolicy: Always
   livenessProbe:
     httpGet:

helm/values-uat.yaml

@@ -4,7 +4,7 @@ microservice-chart:
   fullnameOverride: ""
   image:
     repository: ghcr.io/pagopa/pagopa-debt-position
-    tag: "0.11.27"
+    tag: "0.11.27-1-PAGOPA-1744-getDebtPositionByIUV"
     pullPolicy: Always
   livenessProbe:
     httpGet:

integration-test/src/features/debt-position-manage.feature

@@ -8,37 +8,32 @@ Feature: Managing a debt position
     When the debt position is created
     Then the debt position gets the status code 201
     And the organization gets the nav value after creation
-
-  Scenario: Debt position notification fee update
+    # Debt position notification fee update
     When the notification fee of the debt position is updated
     Then the organization gets the status code 209
     And the organization gets the updated amounts
-
-  Scenario: Debt position filter list by status and due date
+    # Debt position filter list by status and due date
     Given the filter made by status "DRAFT"
     And the filter made by due date from today to 10 days
     When we ask the list of organizations debt positions
     Then we get the status code 200
-
-  Scenario: Debt position filter list by payment date
+    # Debt position filter list by payment date
     Given the filter made by payment date from today to 20 days
     When we ask the list of organizations debt positions
     Then we get the status code 200
-
-  Scenario: Debt position update
+    # Debt position update
     When the debt position is updated
     Then the organization gets the update status code 200
     And the organization gets the nav value after update
-
-  Scenario: Debt position get
+    # Debt position get
     When we get the debt position
     Then the company name is "Testing S.p.A."
     And the organization get the nav value
-
-  Scenario: Debt position deleted
+    # Debt position deleted
     When the debt position is deleted
     Then the debt position gets the status code 200
 
+
   Scenario: Debt position filter list: exclusive param violation
     Given the filter made by due date from today to 10 days
     And the filter made by payment date from today to 20 days

integration-test/src/features/debt-position-pay.feature

@@ -7,16 +7,13 @@ Feature: Paying a debt position
    Given a random iupd
    When the debt position is created
    Then the debt position gets the status code 201
-
- Scenario: Debt position publication
+   # Debt position publication
    When the debt position is published
    Then the debt position gets the status code 200
    And the organization gets the nav value after publication
-
- Scenario: Payment option payment
+   # Payment option payment
    When the payment option is paid
    Then the payment option gets the status code 200
-
- Scenario: Reporting the transfer
+   # Reporting the transfer
    When the transfer is reported
    Then the transfer gets the status code 200

integration-test/src/features/debt-position-retrieval.feature

@@ -0,0 +1,14 @@
+Feature: Retrieve a debt position
+
+  Background: 
+    Given GPD running
+
+  Scenario: Get Debt Position by IUV
+    # Remove dirty data -> create Payment Positions -> Get Payment Position by IUV
+    Given the debt position with IUPD 77777777777_GET_PP_BY_IUV is deleted
+    Given the debt position with IUPD 77777777777_GET_PP_BY_IUV and payment option with IUV 99000000000000000 is created
+    Then the response returns the status code 201
+    When we get the debt position by IUV 99000000000000000
+    Then the response returns the status code 200
+    And the debt position response IUV value is 99000000000000000
+    And the debt position with IUPD 77777777777_GET_PP_BY_IUV is deleted

integration-test/src/features/debt-position-update-and-publish.feature

@@ -5,7 +5,7 @@ Feature: Managing a debt position
 
   Scenario: Debt position creation
     Given a random iupd
-    And a new debt position
-    When the debt position is updated and published
+    When the debt position is created
+    And the debt position is updated and published
     Then the debt position gets the status code 200
     And the debt position gets status "VALID"

integration-test/src/step_definitions/support/clients/gpd_client.js

@@ -115,6 +115,18 @@ function getDebtPosition(orgId, iupd, segCodes) {
     })
 }
 
+function getDebtPositionByIUV(orgId, iuv, segCodes) {
+    const params = {}
+    if (segCodes) {params.segregationCodes = segCodes}
+    return get(GPD_HOST + `/organizations/${orgId}/paymentoptions/${iuv}/debtposition`, {
+        timeout: API_TIMEOUT,
+        headers: {
+            "Ocp-Apim-Subscription-Key": process.env.API_SUBSCRIPTION_KEY,
+            "Content-Type": "application/json"
+        }
+    })
+}
+
 function getPaymentOptionByIuv(orgId, iuv) {
     return get(GPD_HOST + `/organizations/${orgId}/paymentoptions/${iuv}`, {
         timeout: API_TIMEOUT,
@@ -202,6 +214,7 @@ module.exports = {
     updateNotificationFee,
     getDebtPositionList,
     getDebtPosition,
+    getDebtPositionByIUV,
     deleteDebtPosition,
     payPaymentOption,
     reportTransfer,

integration-test/src/step_definitions/support/logic/common_logic.js

@@ -49,6 +49,10 @@ async function assertNav(debtPosition, response) {
     assert.strictEqual(response.paymentOption[0].nav, auxDigit + debtPosition.paymentOption[0].iuv);
 }
 
+async function assertIUV(response, expectedIUV) {
+    assert.strictEqual(response.paymentOption[0].iuv, expectedIUV);
+}
+
 async function assertSize (array, expectedSize){
 	assert.strictEqual(array.length, expectedSize)
 }
@@ -77,6 +81,7 @@ module.exports = {
     randomIupd,
     assertIupd,
     assertNav,
+    assertIUV,
     assertNotificationFeeUpdatedDateNotificationFee,
     assertSize,
     assertMinSize

integration-test/src/step_definitions/support/logic/gpd_logic.js

@@ -12,7 +12,8 @@ const {
     updateAndPublishDebtPosition,
     getPaymentOptionByIuv,
     invalidateDebtPosition,
-    createMassiveDebtPositions
+    createMassiveDebtPositions,
+    getDebtPositionByIUV
 } = require("../clients/gpd_client");
 
 const {
@@ -24,9 +25,9 @@ const {
     buildCreateMassiveDebtPositionRequest
 } = require("../utility/request_builders");
 
-async function executeDebtPositionCreation(bundle, idOrg, iupd) {
+async function executeDebtPositionCreation(bundle, idOrg, iupd, iuv) {
     bundle.organizationCode = idOrg;
-    bundle.debtPosition = buildDebtPositionDynamicData(bundle, iupd);
+    bundle.debtPosition = buildDebtPositionDynamicData(bundle, iupd, iuv);
     let response = await createDebtPosition(bundle.organizationCode, buildCreateDebtPositionRequest(bundle.debtPosition, bundle.payer));
     bundle.responseToCheck = response;
     bundle.createdDebtPosition = bundle.responseToCheck.data;
@@ -124,6 +125,12 @@ async function executeDebtPositionGet(bundle, idOrg, iupd) {
     bundle.responseToCheck = response;
 }
 
+async function executeDebtPositionGetByIuv(bundle, idOrg, iuv) {
+    let response = await getDebtPositionByIUV(idOrg, iuv);
+    bundle.payer.companyName = response.data.companyName;
+    bundle.responseToCheck = response;
+}
+
 async function executeDebtPositionGetWithSegregationCodes(bundle, idOrg, iupd) {
 	let segCodes = bundle.debtPosition.iuv1.slice(0, 2)
     let response = await getDebtPosition(idOrg, iupd, segCodes);
@@ -198,6 +205,7 @@ module.exports = {
     executeDebtPositionUpdate,
     executeDebtPositionNotificationFeeUpdate,
     executeDebtPositionGet,
+    executeDebtPositionGetByIuv,
     executeDebtPositionPublish,
     executePaymentOptionPay,
     executeReportTransfer,

integration-test/src/step_definitions/support/steps.js

@@ -12,6 +12,7 @@ const { executeDebtPositionCreation,
         executeDebtPositionCreationAndPublication,
         executeDebtPositionUpdateAndPublication,
         executePaymentOptionGetByIuv,
+        executeDebtPositionGetByIuv,
         executeOKDebtPositionCreation,
         executeKODebtPositionCreation,
         executeDebtPositionNotificationFeeUpdateNodeOK,
@@ -27,7 +28,9 @@ const { executeDebtPositionCreation,
         executeMassiveDebtPositionCreationWithSegregationCodes
 } = require('./logic/gpd_logic');
 const { assertAmount, assertFaultCode, assertOutcome, assertStatusCode, assertCompanyName, assertNotificationFeeUpdatedAmounts, 
-assertStatusString, executeAfterAllStep, randomOrg, randomIupd, assertIupd, assertNav, assertNotificationFeeUpdatedDateNotificationFee, assertSize, assertMinSize } = require('./logic/common_logic');
+assertStatusString, executeAfterAllStep, randomOrg, randomIupd, assertIupd, assertNav, assertNotificationFeeUpdatedDateNotificationFee, assertSize, assertMinSize,
+    assertIUV
+} = require('./logic/common_logic');
 const { gpdSessionBundle, gpdUpdateBundle, gpdPayBundle } = require('./utility/data');
 const { getValidBundle, addDays, format } = require('./utility/helpers');
 
@@ -56,7 +59,6 @@ BeforeAll(async function() {
  */
 Given('GPD running', () => executeHealthCheckForGPD());
 
-
 /*
  *  Debt position creation
  */
@@ -65,15 +67,16 @@ Given('a random iupd', async function () {
     // precondition -> deletion possible dirty data
     await executeDebtPositionDeletion(gpdSessionBundle, idOrg, iupd);
     });
-When('the debt position is created', () => executeDebtPositionCreation(gpdSessionBundle, idOrg, iupd, status));
+When(/^the debt position with IUPD (.*) and payment option with IUV (.*) is created$/, (IUPD_input, iuv) => executeDebtPositionCreation(gpdSessionBundle, idOrg, IUPD_input, iuv));
+When('the debt position is created', () => executeDebtPositionCreation(gpdSessionBundle, idOrg, iupd));
 Then('the debt position gets the status code {int}', (statusCode) => assertStatusCode(gpdSessionBundle, statusCode));
 Then('the organization gets the nav value after creation', () => assertNav(gpdSessionBundle.createdDebtPosition, gpdSessionBundle.responseToCheck.data));
 
 /*
  *  Massive debt positions creation
  */
 
-When('the debt position items is created', () => executeMassiveDebtPositionsCreation(gpdSessionBundle, idOrg, iupd, status));
+When('the debt position items is created', () => executeMassiveDebtPositionsCreation(gpdSessionBundle, idOrg, iupd));
 
 
 /*
@@ -128,14 +131,16 @@ Then('the organization gets the nav value after update', () => assertNav(gpdSess
  *  Debt position get
  */
 When('we get the debt position', () => executeDebtPositionGet(gpdSessionBundle, idOrg, iupd));
+When(/^we get the debt position by IUV (.*)$/, (iuv) => executeDebtPositionGetByIuv(gpdSessionBundle, idOrg, iuv));
 Then('the company name is {string}', (companyName) => assertCompanyName(gpdSessionBundle, companyName));
 Then('the organization get the nav value', () => assertNav(gpdSessionBundle.responseToCheck.data, gpdSessionBundle.responseToCheck.data))
+Then(/^the debt position response IUV value is (.*)$/, (expectedIUV) => assertIUV(gpdSessionBundle.responseToCheck.data, expectedIUV))
 
 /*
  *  Debt position delete
  */
 When('the debt position is deleted', () => executeDebtPositionDeletion(gpdSessionBundle, idOrg, iupd));
-
+Then(/^the debt position with IUPD (.*) is deleted$/, (IUPD_input) => executeDebtPositionDeletion(gpdSessionBundle, idOrg, IUPD_input));
 
 /*
  *  Debt position publish
@@ -161,6 +166,7 @@ Then('the payment option gets the status code {int}', (statusCode) => assertStat
  */
 When('we get the payment option by iuv', () => executePaymentOptionGetByIuv(gpdSessionBundle, idOrg, gpdSessionBundle.debtPosition.iuv1));
 Then('the get payment options returns the status code {int}', (statusCode) => assertStatusCode(gpdSessionBundle, statusCode));
+Then('the response returns the status code {int}', (statusCode) => assertStatusCode(gpdSessionBundle, statusCode));
 Then('the iupd is present and valued with the same value as the debt position', () => assertIupd(gpdSessionBundle));
 
 /*
@@ -175,14 +181,13 @@ Then('the transfer gets the status code {int}', (statusCode) => assertStatusCode
 When('the debt position is created and published', () => executeDebtPositionCreationAndPublication(gpdSessionBundle, idOrg, iupd));
 Then('the debt position gets status {string}', (statusString) => assertStatusString(gpdSessionBundle, statusString));
 
-Given('a new debt position', () => executeDebtPositionCreation(gpdSessionBundle, idOrg, iupd, status));
 When('the debt position is updated and published', () => executeDebtPositionUpdateAndPublication(gpdSessionBundle, idOrg, iupd));
 
 /*
  * Debt position manage with segregation codes
  */
 
- When('the debt position using segregation codes is created', () => executeDebtPositionCreationWithSegregationCodes(gpdSessionBundle, idOrg, iupd, status));
+ When('the debt position using segregation codes is created', () => executeDebtPositionCreationWithSegregationCodes(gpdSessionBundle, idOrg, iupd));
  When('the debt position items, using segregation codes, is created', () => executeMassiveDebtPositionCreationWithSegregationCodes(gpdSessionBundle, idOrg, iupd, status));
  When('the debt position using segregation codes is updated', () => executeDebtPositionUpdateWithSegregationCodes(gpdSessionBundle, gpdUpdateBundle, idOrg, iupd));
  When('the organization gets the debt position using segregation codes', () => executeDebtPositionGetWithSegregationCodes(gpdSessionBundle, idOrg, iupd));

integration-test/src/step_definitions/support/utility/request_builders.js

@@ -1,9 +1,9 @@
 const { addDays, buildStringFromDate, makeidNumber, makeidMix,  } = require("./helpers");
 
-function buildDebtPositionDynamicData(gpdSessionBundle, iupdIn) {
+function buildDebtPositionDynamicData(gpdSessionBundle, iupdIn, iuv = makeidNumber(17)) {
     return {
         iupd: iupdIn,
-        iuv1: makeidNumber(17),
+        iuv1: iuv,
         iuv2: makeidNumber(17),
         iuv3: makeidNumber(17),
         iuvOK: process.env.iuv_ok,  // es. "11101751670642134"

openapi/openapi_external.json

@@ -4,7 +4,7 @@
     "title": "PagoPA API Debt Position",
     "description": "Progetto Gestione Posizioni Debitorie",
     "termsOfService": "https://www.pagopa.gov.it/",
-    "version": "0.11.27"
+    "version": "0.11.27-1-PAGOPA-1744-getDebtPositionByIUV"
   },
   "servers": [
     {

openapi/openapi_external_massive.json

@@ -4,7 +4,7 @@
     "title": "PagoPA API Debt Position",
     "description": "Progetto Gestione Posizioni Debitorie",
     "termsOfService": "https://www.pagopa.gov.it/",
-    "version": "0.11.27"
+    "version": "0.11.27-1-PAGOPA-1744-getDebtPositionByIUV"
   },
   "servers": [
     {