Focus sulla validazione dei test con il tool PnValidator

Approfondimento sul tool PnValidator per facilitare il superamento dei test di validazione

Come avviare il tool in modalità "debug" per ottenere in console il dettaglio delle chiamate eseguite sul terminale

E' possibile avviare il tool in modalità "debug" con il seguente comando:

docker run -p 3000:3000 -e LOG_LEVEL=debug ghcr.io/pagopa/pn-local-emulator:latest

Se l'avvio in modalità "debug" è avvenuto con successo, nella console del container apparirà:

2023-06-21T10:02:04: PM2 log: Launching in no daemon mode
2023-06-21T10:02:04: PM2 log: App [main:0] starting in -fork mode-
2023-06-21T10:02:04: PM2 log: App [main:0] online
2023-06-21 10:02:05.340
INFO  [src/adapters/http/application.ts:50 Server.<anonymous>]
Server is listening on 0.0.0.0:3000
2023-06-21 10:02:05.343  INFO  [src/adapters/http/application.ts:51 Server.<anonymous>] Server uploadToS3URL is http://127.0.0.1:3000/uploadS3
2023-06-21 10:02:05.344  INFO  [src/adapters/http/application.ts:52 Server.<anonymous>] Server downloadDocumentURL is http://127.0.0.1:3000/download

e per ogni chiamata verso i servizi esposti dal tool si avranno dei logs come questi:

2023-06-21 10:02:10.487  DEBUG [src/adapters/inMemory/index.ts:15  insert]
Record item: {"type":"PreLoadRecord","input":{"apiKey":"key-value","body":[{"preloadIdx":"doc1","contentType":"application/pdf","sha256":"Fq9Vn4gAxHvvcaS0P6DGZOJ0/HjoViGOYwV7Hk7BRlM="},{"preloadIdx":"pagoPa1","contentType":"application/pdf","sha256":"XqCaFsS72IEAh6QuJTkE3C5JHXF/0HVtuCchU5D12OU="}]},"loggedAt":"2023-06-21T10:02:10.479Z","output":{"statusCode":200,"returned":[{"preloadIdx":"doc1","secret":"UDKZ-QHJL-GVAN-135652-P-6","httpMethod":"PUT","key":"XMUX-IJRB-KPRA-441819-L-1","url":"http://127.0.0.1:3000/uploadS3/XMUX-IJRB-KPRA-441819-L-1?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIDEXAMPLE%2F20150830%2Fus-east-1%2Fiam%2Faws4_request&X-Amz-SignedHeaders=content-type%3Bhost%3Bx-amz-checksum-sha256%3Bx-amz-meta-secret&X-Amz-Security-Token=IQoJbJf%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCmV1i3c%2BbxI%2BJMzP%2BPRXYj%2Fe2G%2Fti%2FQkj3KnOPr"},{"preloadIdx":"pagoPa1","secret":"OQBN-IHWB-CIJD-156762-L-7","httpMethod":"PUT","key":"ZPMZ-KQQU-JUTY-758481-J-5","url":"http://127.0.0.1:3000/uploadS3/ZPMZ-KQQU-JUTY-758481-J-5?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIDEXAMPLE%2F20150830%2Fus-east-1%2Fiam%2Faws4_request&X-Amz-SignedHeaders=content-type%3Bhost%3Bx-amz-checksum-sha256%3Bx-amz-meta-secret&X-Amz-Security-Token=IQoJbJf%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCmV1i3c%2BbxI%2BJMzP%2BPRXYj%2Fe2G%2Fti%2FQkj3KnOPr"}]}}

Dove si può vedere il type della chiamata, la data di esecuzione loggedAt ed infine l'input e l'output per ogni servizio.

Non riesco a portare in true le domande: "Have you created at least one valid notification?", "Have you upload two files using the information of previous step?" e "Have you uploaded one file using the information of previous step?"

In alcuni casi nonostante il tool non sollevi un'eccezione e faccia continuare l'inserimento notifica positivamente, potrebbe capitare che alcune di queste domande non vengano portate in true poichè non vengono rispettati fedelmente i passaggi collegati all'upload dei documenti. Di seguito alcuni consigli per superare questa fase:

• E' fondamentale associare correttamente il ref.key durante la fase di richiesta di inserimento notifica, il quale dovrà coincidere con quello che si ottiene nella response della chiamata al servizio di presignedUploadRequest in relazione all'allegato corrispondente.

• E' fondamentale verificare che il campo x-amz-version-id, ottenuto come header della response collegata all'esito positivo dell'upload dell'allegato, sia valorizzato correttamente nel campo ref.versionToken in corrispondenza del documento ad esso associato, nella richiesta di inserimento notifica.

• Durante la fase di upload del documento bisogna fare attenzione che si stia caricando effettivamente il documento corretto, che lo sha256 sia stato generato correttamente e che questo corrisponda durante le fasi di preload documento, upload documento ed inserimento richiesta di notifica.

Non riesco a portare in true la domanda: "Have you honored the retry-after value?"

Questa domanda è l'unica del report che appare in true fin dall'inizio e che diventa false se non viene rispettata la logica del retry-after durante la fase di interrogazione degli stream; una volta passata in false, sarà necessario stoppare e riavviare il tool per completarne la validazione. Nel contesto del tool, la verifica del rispetto del parametro retry-after viene effettuata NON sul singolo stream ma globalmente sul servizio pertanto per semplificare questo processo, si consiglia di configurare ed utilizzare un solo stream di eventType: TIMELINE durante la fase di convalida dei test.

Non riesco a portare in true le domande: "Have you downloaded the PDF of the legal facts?" e "Have you requested the metadata of the legal facts?"

Queste domande sono collegate al download dei legalFacts che vengono generati dal tool (si tratta di documenti fittizi) a seguito del buon esito dell'inserimento della notifica. Le domande passano in true se si chiama prima il servizio retrieveLegalFact e subito dopo si effettua il download del documento con i meta-dati ottenuti; mentre passano in false se non corrisponde il download del documento in corrispondenza di OGNI chiamata al servizio retrieveLegalFact. Questo passaggio è composto da 2 fasi:

1) Effettuare la richiesta per ottenere la url per scaricare un legalFact:

Chiamata con metodo GET su endpoint http://<urlValidator>/delivery-push/<iunDellaNotifica>/legal-facts/<legalFactType>/<legalFactId>.

Sostituendo i seguenti:

• <urlValidator>: inserire la url del validator (se avviato con le istruzioni standard è localhost:3000)

• <iunDellaNotifica>: è lo IUN della notifica inserita verso il validator

• <legalFactType>: è il legalFactType del documento che si vuole scaricare

• <legalFactId>: è il legalFactId del documento che si vuole scaricare

Si ottiene la seguente risposta:

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"filename": "dummy-filename",
"contentLength": 10,
"url": "http://0.0.0.0:3000/download/sample.pdf?correlation-id=GVSJ-EDOR-XJJU-526955-P-0"
}

Dove correlation-id è un codice di riferimento per il documento richiesto ed è gestito dal tool. Dopo questa chiamata il check "Have you requested the metadata of the legal facts?" sarà valorizzato a true.

2) Effettuare il download del legalFact

Effettuare una richiesta GET sull’URL restituito nella chiamata precedente:

NOTA: fare attenzione che il correlation-id corrisponda a quello ottenuto nella chiamata precedente

Dopo aver eseguito questa chiamata ed aver scaricato il pdf restituito in locale, il check "Have you downloaded the PDF of the legal facts?" sarà valorizzato a true.

ATTENZIONE: Quando si richiede l’URL di download di un legalFact, il check "Have you downloaded the PDF of the legal facts?" diventa false, poichè il sistema si attende che venga finalizzato il download invocando l’URL restituito dalla chiamata. Se per qualche motivo si perde l’URL restituito (ovvero quello che contiene correlation-id), non sarà più possibile far valorizzare a true il check e sarà necessario riavviare il tool ed eseguire da capo la validazione.

NOTA: si evidenzia che è sufficiente scaricare anche solo il legalFact con category SENDER_ACK per convalidare questo test.