Menu

Come utilizzare l'integrazione della riga di comando con Newman in Postman?

  • Principale
  • Altro
  • Come utilizzare l'integrazione della riga di comando con Newman in Postman?

how use command line integration with newman postman

Prova Il Nostro Strumento Per Eliminare I Problemi

Impara a eseguire raccolte Postman utilizzando Newman:

In questo tutorial vedremo come possiamo integrare o eseguire raccolte di Postman tramite la riga di comando utilizzando Newman, uno strumento di integrazione della riga di comando per Postman.

Newman è uno strumento gratuito e open source. Fornisce potenti funzionalità per eseguire le raccolte Postman, sfruttando le funzionalità super utili di Postman come test, asserzioni, script di pre-richiesta, ecc. Ed eseguendo la raccolta tramite la riga di comando.

=> Controlla qui per vedere qui i tutorial di formazione dalla A alla Z del postino.

Postman_ Integrazione della riga di comando con Newman

Cosa imparerai:

Cos'è Newman?

Newman è un runner della riga di comando per le raccolte Postman. In altre parole, consente a un utente di eseguire una raccolta Postman esistente tramite la riga di comando.

Si aspetta o consuma la versione JSON della raccolta che può essere ottenuta semplicemente esportando la raccolta nel formato di raccolta JSON o l'URL della raccolta che non è altro che lo stesso JSON ottenuto dall'esportazione della raccolta.

Ecco un video tutorial:

Installazione di Newman

Newman è un modulo NodeJS e quindi dipende dal sistema su cui è installato il nodo. Per verificare se il nodo è installato o meno, è sufficiente controllare la versione del nodo sul sistema utilizzando il comando seguente.

$ node -v v10.15.3

Se il comando restituisce un output come sopra, significa che il nodo è installato e siamo a posto con l'installazione di Newman. In caso contrario, puoi installare node facendo riferimento alle istruzioni di installazione Qui

Una volta completata l'installazione del nodo, puoi semplicemente installare Newman come qualsiasi altro pacchetto del nodo utilizzando il comando seguente.

npm install -g newman

Qui '-g' denota installazione globale, il che significa che il pacchetto Newman sarà accessibile da qualsiasi cartella / posizione nel file system. Per eseguire un'installazione locale, è possibile rimuovere il flag '-g' da sopra, dove il pacchetto Newman sarà accessibile solo dalla posizione o dalla cartella di installazione.

Per convalidare la corretta installazione di Newman, puoi semplicemente controllare la sua versione utilizzando il comando seguente.

newman -v 4.5.1

Esecuzione di raccolte utilizzando Newman

Per eseguire le raccolte utilizzando Newman, dovresti avere uno dei 2.

  1. La raccolta in formato JSON.
  2. URL della raccolta ospitata.

Il comando utilizzato per eseguire la raccolta Postman utilizzando Newman è:

convertitore da youtube a wav online gratuito
newman run {{collectionJsonPath}} OR newman run {{collectionUrl}}

Proviamo a eseguire una raccolta di esempio utilizzando Postman.

  1. Vai all'applicazione Postman, usa qualsiasi raccolta Postman esistente ed esportala in formato JSON. (Creeremo una nuova raccolta con 3 richieste, ovvero Registra utente, Accedi utente e Ottieni utente utilizzando il modulo degli endpoint API Qui ).
  2. Ora esporta la raccolta in formato JSON.
  3. Una volta ottenuto il JSON della raccolta, aprire un prompt dei comandi ed eseguire la raccolta utilizzando il comando di esecuzione di Newman (supponiamo che la raccolta sia stata esportata con il nome - Postman_Newman_IntegrationCollection .json) e l'utente è passato alla directory di esportazione della raccolta, quindi la raccolta può essere eseguita semplicemente utilizzando il comando seguente.
newman run Postman_Newman_IntegrationCollection.json

Una volta eseguito il comando precedente, viene prodotto il seguente output.

Collezione Runner

Integrazione di Newman con variabili d'ambiente

Vediamo ora utilizzi più avanzati di Newman. Per una raccolta che non si basa su alcuna variabile di ambiente, la raccolta potrebbe essere semplicemente eseguita utilizzando il comando di esecuzione di Newman. Ma per le raccolte, utilizzando le variabili di ambiente, è necessario fornire anche la variabile di ambiente JSON insieme alla raccolta JSON.

Esempio: Useremo la stessa raccolta e utilizzeremo una variabile di ambiente per l'endpoint utente GET, ad esempio per la richiesta con endpoint .

Useremo userId dalla raccolta di variabili d'ambiente. Quindi la richiesta risultante diventerà https://reqres.in/api/users/{{userId}}

Ora, una volta creato il file di ambiente, esportalo come JSON, utilizzando i passaggi seguenti.

  1. Crea un ambiente, con una variabile denominata userId e il valore deve essere impostato su '4'.
  2. Ora, fai clic sul pulsante Impostazioni per aprire la finestra 'Gestisci ambienti'.
  3. Fare clic sull'icona 'Download' nell'ambiente creato per scaricare l'ambiente come file JSON (salvare il file con il nome 'testEnv.json).

Esportiamo di nuovo la raccolta con la richiesta modificata e proviamo a eseguire la stessa raccolta insieme al file di ambiente con il comando come di seguito:

newman run Postman_Newman_IntegrationCollection.json -e testEnv.json

Una volta eseguito il comando precedente, l'output rimane lo stesso dell'esecuzione della raccolta diretta, con l'unica modifica che la richiesta 'GET User' ora recupera il valore dal file JSON dell'ambiente.

Risultati dell'asserzione utilizzando Newman

Poiché le richieste di Postman possono contenere anche asserzioni, ora verrà illustrato come vengono visualizzati i risultati delle asserzioni quando le raccolte di Postman vengono eseguite tramite Newman.

Il corridore della raccolta Newman è in completa parità con il corridore della raccolta Postman e l'esecutore della richiesta. Per le richieste che contengono asserzioni, le asserzioni vengono valutate man mano che l'esecuzione della richiesta viene completata e il riepilogo dell'esecuzione dell'asserzione viene visualizzato nel riepilogo del test alla fine dell'esecuzione del test.

Per la raccolta precedente, abbiamo aggiunto un'asserzione a livello di raccolta per verificare che il codice di stato della risposta sia 200, ovvero per ogni richiesta che fa parte della raccolta dovrebbe essere associata questa asserzione.

Quindi, se questa raccolta aveva 3 richieste, significa che dovrebbe esserci un totale di 3 asserzioni che avrebbero dovuto essere eseguite.

Fare riferimento allo screenshot di seguito per i risultati di esecuzione evidenziati e i risultati di asserzione.

Risultati di esecuzione evidenziati

Generazione di report utilizzando Newman

Finora sappiamo che Newman può eseguire raccolte Postman tramite la riga di comando e generare alcuni log di test e un riepilogo dell'esecuzione dei test. Ma per quanto riguarda i report formattati che potrebbero essere condivisi o pubblicati su qualche server?

Bene, anche Newman ha il supporto per questo. Sono disponibili alcuni moduli di nodi personalizzati per la generazione di report di esecuzione dei test Newman. Esamineremo un esempio utilizzando un file newman-html-reporter .

Questo reporter è di nuovo un modulo nodo e deve essere installato separatamente utilizzando il comando seguente.

npm install -g newman-reporter-html

Una volta installato il modulo sopra, questo può essere utilizzato insieme al comando di esecuzione di Newman.

newman run Postman_Newman_IntegrationCollection.json -e testEnv.json -r html

Il flag '-r' indica il reporter da utilizzare con la raccolta Newman eseguita.

Con questa opzione, utilizza il modulo oi pacchetti Newman-reporter-html e crea un report basato su HTML per l'esecuzione del test.

Fare riferimento a uno di questi screenshot del report HTML mostrato di seguito:

Rapporto HTML

Integrazione con strumenti CI

Con Newman che ha le capacità di funzionare come una riga di comando, riduce molta dipendenza da qualsiasi prerequisito sotto forma di una console o un'applicazione, cioè l'unica dipendenza che Newman haèun nodo (che è generalmente disponibile come esecuzione ambiente in tutte le macchine CI come gli schiavi Jenkins oi nodi Travis).

Ciò consente di eseguire le raccolte di Postman come parte delle pipeline di compilazione stesse tramite la riga di comando di Newman.

Con Newman che ha la capacità di inviare i risultati anche in formato Html, questo è davvero utile e pratico e durante l'esecuzione della pipeline stessa, i risultati HTML potrebbero essere inviati a un server o possono essere inviati tramite e-mail agli utenti desiderati, ecc. le capacità sono infinite poiché le dipendenze sono minime.

Per un esempio di esecuzione dettagliato end-to-end dell'integrazione con Jenkins, fare riferimento a questo esempio dal blog ufficiale di Postman Qui .

Più opzioni con Newman

Qualunque cosa abbiamo trattato è un sottoinsieme delle funzionalità fornite da Newman. Per i dettagli completi dei comandi e delle opzioni supportati da Newman, è sufficiente aprire la guida della riga di comando per Newman utilizzando il comando seguente.

newman run -h

Ecco l'output del comando precedente, con i dettagli su tutti gli interruttori e il loro significato.

Uscita con interruttori e loro significato

Sono disponibili anche altre risorse informative per il riferimento all'API Newman. Per favore, riferisci Qui per la documentazione ufficiale.

Conclusione

In questo tutorial, abbiamo illustrato l'integrazione della riga di comando di Postman denominata Newman, che consente di eseguire le raccolte di Postman tramite un'interfaccia della riga di comando.

È semplicemente un pacchetto di nodi e qualsiasi riga di comando su cui è installato il nodo insieme a Newman dovrebbe essere in grado di eseguire la raccolta Postman e generare rapporti di bell'aspetto dell'esecuzione della raccolta.

L'integrazione della riga di comando è anche di grande aiuto per l'integrazione dei test di raccolta basati su Postman con strumenti CI come Jenkins, Travis, ecc., Poiché l'esecuzione tramite la riga di comando non ha alcuna dipendenza dal sistema operativo o dall'applicazione e ha semplicemente bisogno dell'ambiente del nodo per eseguire il collezione.

=> Visita qui per l'esclusiva serie di tutorial sull'addestramento del postino.

Lettura consigliata

^