how use command line integration with newman postman
Μάθετε να εκτελείτε συλλογές Postman χρησιμοποιώντας το Newman:
Σε αυτό το σεμινάριο, θα δούμε πώς μπορούμε να ενσωματώσουμε ή να εκτελέσουμε συλλογές Postman μέσω της γραμμής εντολών χρησιμοποιώντας το Newman, το οποίο είναι ένα εργαλείο ολοκλήρωσης γραμμής εντολών για τον Postman.
Το Newman είναι ένα δωρεάν και ανοιχτού κώδικα εργαλείο. Παρέχει ισχυρές δυνατότητες για την εκτέλεση των συλλογών Postman, αξιοποιώντας τις εξαιρετικά χρήσιμες δυνατότητες του Postman όπως Tests, Assertions, scripts προ-αιτήματος κ.λπ. και εκτελώντας τη συλλογή μέσω της γραμμής εντολών.
=> Δείτε εδώ για να δείτε το A-Z Of Postman Training Tutorials.
Τι θα μάθετε:
Τι είναι ο Νιούμαν;
Ο Newman είναι δρομέας γραμμής εντολών για συλλογές Postman. Με άλλα λόγια, επιτρέπει στον χρήστη να εκτελεί μια υπάρχουσα συλλογή Postman μέσω της γραμμής εντολών.
Αναμένει ή καταναλώνει την έκδοση JSON της συλλογής που μπορεί να ληφθεί απλώς εξάγοντας τη συλλογή σε μορφή συλλογής JSON ή τη διεύθυνση URL της συλλογής που δεν είναι τίποτα άλλο από το ίδιο JSON που λαμβάνεται από την εξαγωγή συλλογής.
Εδώ είναι ένα εκπαιδευτικό βίντεο:
Εγκατάσταση του Newman
Το Newman είναι μια μονάδα NodeJS και έτσι εξαρτάται από το σύστημα που έχει εγκατεστημένο τον κόμβο. Για να ελέγξετε εάν ο κόμβος είναι εγκατεστημένος ή όχι, απλώς ελέγξτε την έκδοση κόμβου στο σύστημα χρησιμοποιώντας την παρακάτω εντολή.
$ node -v v10.15.3Εάν η εντολή επιστρέψει κάποια έξοδο όπως παραπάνω, τότε σημαίνει ότι ο κόμβος είναι εγκατεστημένος και καλό είναι να ξεκινήσουμε με την εγκατάσταση του Newman. Εάν όχι, μπορείτε να εγκαταστήσετε τον κόμβο αναφέροντας τις οδηγίες εγκατάστασης εδώ
Μόλις η εγκατάσταση του κόμβου είναι επιτυχής, μπορείτε απλά να εγκαταστήσετε το Newman όπως οποιοδήποτε άλλο πακέτο κόμβων χρησιμοποιώντας την παρακάτω εντολή.
npm install -g newmanΕδώ «-g» σημαίνει καθολική εγκατάσταση που σημαίνει ότι το πακέτο Newman θα είναι προσβάσιμο από οποιονδήποτε φάκελο / τοποθεσία στο σύστημα αρχείων. Για να κάνετε μια τοπική εγκατάσταση, μπορείτε να αφαιρέσετε τη σημαία «-g» από τα παραπάνω, όπου το πακέτο Newman θα είναι προσβάσιμο μόνο από την εγκατεστημένη τοποθεσία ή το φάκελο.
Για να επικυρώσετε την επιτυχή εγκατάσταση του Newman, μπορείτε απλώς να ελέγξετε την έκδοσή του χρησιμοποιώντας την παρακάτω εντολή.
newman -v 4.5.1Εκτέλεση συλλογών με χρήση του Newman
Για να εκτελέσετε συλλογές χρησιμοποιώντας το Newman, θα πρέπει να έχετε ένα από τα 2.
- Η συλλογή σε μορφή JSON.
- URL της φιλοξενούμενης συλλογής.
Η εντολή που χρησιμοποιήθηκε για την εκτέλεση της συλλογής Postman χρησιμοποιώντας το Newman είναι:
δωρεάν μετατροπέας youtube σε mp4 δωρεάν χωρίς λήψη
newman run {{collectionJsonPath}} OR newman run {{collectionUrl}}Ας δοκιμάσουμε να εκτελέσουμε μια συλλογή δείγματος χρησιμοποιώντας το Postman.
- Μεταβείτε στην εφαρμογή Postman, χρησιμοποιήστε οποιαδήποτε υπάρχουσα συλλογή Postman και εξαγάγετέ την στη φόρμα JSON. (Θα δημιουργήσουμε μια νέα συλλογή με 3 αιτήματα, δηλαδή Εγγραφή χρήστη, Χρήστης σύνδεσης και Λήψη χρήστη χρησιμοποιώντας τη φόρμα τελικών σημείων API εδώ ).
- Τώρα εξαγάγετε τη συλλογή σε μορφή JSON.
- Μόλις ληφθεί η συλλογή JSON, ανοίξτε μια γραμμή εντολών και εκτελέστε τη συλλογή χρησιμοποιώντας την εντολή Newman run (ας υποθέσουμε ότι η συλλογή εξήχθη με όνομα - Postman_Newman_IntegrationCollection .json) και ο χρήστης έχει περιηγηθεί στον κατάλογο εξαγωγής συλλογής, τότε η συλλογή μπορεί να εκτελεστεί απλά χρησιμοποιώντας την παρακάτω εντολή.
newman run Postman_Newman_IntegrationCollection.jsonΜόλις εκτελεστεί η παραπάνω εντολή, παράγεται η ακόλουθη έξοδος.
Ενσωμάτωση Newman με μεταβλητές περιβάλλοντος
Ας δούμε πιο προηγμένες χρήσεις του Newman. Για μια συλλογή που δεν βασίζεται σε μεταβλητές περιβάλλοντος, η συλλογή θα μπορούσε απλώς να εκτελεστεί χρησιμοποιώντας την εντολή Newman run. Αλλά για τις συλλογές, χρησιμοποιώντας τις μεταβλητές περιβάλλοντος, πρέπει να παρέχουμε τη μεταβλητή περιβάλλοντος JSON, καθώς και τη συλλογή JSON.
Παράδειγμα: Θα χρησιμοποιήσουμε την ίδια συλλογή και θα χρησιμοποιήσουμε μια μεταβλητή περιβάλλοντος για το τελικό σημείο χρήστη GET, δηλαδή για αίτηση με τελικό σημείο .
Θα χρησιμοποιήσουμε το userId από τη συλλογή μεταβλητών περιβάλλοντος. Επομένως, το προκύπτον αίτημα θα γίνει https://reqres.in/api/users/{{userId}}
Τώρα μόλις δημιουργηθεί το αρχείο περιβάλλοντος, εξαγάγετέ το ως JSON, ακολουθώντας τα παρακάτω βήματα.
- Δημιουργήστε ένα περιβάλλον, με μία μεταβλητή με το όνομα userId και η τιμή πρέπει να οριστεί σε '4'.
- Τώρα, κάντε κλικ στο κουμπί Ρυθμίσεις, για να ανοίξετε το παράθυρο «Διαχείριση περιβάλλοντος».
- Κάντε κλικ στο εικονίδιο «Λήψη» στο δημιουργημένο περιβάλλον για να κατεβάσετε το περιβάλλον ως αρχείο JSON (αποθηκεύστε το αρχείο με όνομα ως «testEnv.json).
Ας εξαγάγουμε ξανά τη συλλογή με το αλλαγμένο αίτημα και δοκιμάστε να εκτελέσετε την ίδια συλλογή μαζί με το αρχείο περιβάλλοντος με την εντολή όπως παρακάτω:
newman run Postman_Newman_IntegrationCollection.json -e testEnv.jsonΜόλις εκτελεστεί η παραπάνω εντολή, η έξοδος παραμένει η ίδια με την εκτέλεση της άμεσης συλλογής, με τη μόνη αλλαγή να είναι το αίτημα «GET User», παίρνει τώρα την τιμή από το αρχείο JSON περιβάλλοντος.
Αποτελέσματα επιβεβαίωσης με χρήση του Newman
Καθώς τα αιτήματα του Ταχυδρόμου μπορούν επίσης να περιέχουν ισχυρισμούς, θα εξετάσουμε τώρα πώς θα εμφανιστούν τα αποτελέσματα των ισχυρισμών όταν οι συλλογές του Ταχυδρόμου εκτελούνται μέσω ενός Νιούμαν.
Ο δρομέας συλλογής Newman βρίσκεται σε πλήρη ισορροπία με τον δρομέα συλλογής Postman και τον εκτελεστή αιτήσεων. Για αιτήματα που έχουν ισχυρισμούς, οι ισχυρισμοί αξιολογούνται όταν και όταν ολοκληρωθεί η εκτέλεση του αιτήματος και η περίληψη της εκτέλεσης των ισχυρισμών εμφανίζεται στην περίληψη δοκιμής στο τέλος της δοκιμαστικής εκτέλεσης.
Για την παραπάνω συλλογή, προσθέσαμε μια δήλωση επιπέδου συλλογής για να ελέγξουμε τον κωδικό κατάστασης της απόκρισης να είναι 200, δηλαδή για κάθε αίτημα που αποτελεί μέρος της συλλογής θα πρέπει να υπάρχει αυτή η δήλωση.
Επομένως, εάν αυτή η συλλογή είχε 3 αιτήματα, αυτό σημαίνει ότι πρέπει να υπάρχουν συνολικά 3 ισχυρισμοί που θα έπρεπε να είχαν εκτελεστεί.
Ανατρέξτε στο παρακάτω στιγμιότυπο οθόνης για επισημασμένα αποτελέσματα εκτέλεσης και αποτελέσματα επιβεβαίωσης.
Αναφορά δημιουργίας με χρήση του Newman
Μέχρι στιγμής γνωρίζουμε ότι ο Newman μπορεί να εκτελεί συλλογές Postman μέσω της γραμμής εντολών και να δημιουργεί μερικά αρχεία καταγραφής δοκιμών και περίληψη εκτέλεσης δοκιμής. Τι γίνεται όμως με τις μορφοποιημένες αναφορές που θα μπορούσαν να κοινοποιηθούν ή να δημοσιευτούν σε κάποιο διακομιστή;
Λοιπόν, ο Νιούμαν έχει επίσης υποστήριξη για αυτό. Υπάρχουν κάποιες προσαρμοσμένες λειτουργικές μονάδες κόμβου για τη δημιουργία αναφορών εκτέλεσης δοκιμών Newman. Θα δούμε ένα παράδειγμα χρησιμοποιώντας ένα newman-html-ρεπόρτερ .
Αυτός ο ανταποκριτής είναι και πάλι μια μονάδα κόμβου και πρέπει να εγκατασταθεί ξεχωριστά χρησιμοποιώντας την παρακάτω εντολή.
npm install -g newman-reporter-htmlΜόλις εγκατασταθεί η παραπάνω λειτουργική μονάδα, αυτό μπορεί να χρησιμοποιηθεί μαζί με την εντολή Newman run.
newman run Postman_Newman_IntegrationCollection.json -e testEnv.json -r htmlΗ σημαία «-r» υποδηλώνει ότι ο δημοσιογράφος θα χρησιμοποιηθεί με την εκτέλεση της συλλογής Newman.
Με αυτήν την επιλογή, χρησιμοποιεί τη μονάδα ή τα πακέτα Newman-reporter-html και δημιουργεί μια αναφορά βασισμένη σε HTML για την εκτέλεση της δοκιμής.
Ανατρέξτε σε ένα τέτοιο στιγμιότυπο οθόνης της αναφοράς HTML που εμφανίζεται παρακάτω:
Ενσωμάτωση με εργαλεία CI
Με το Newman να έχει τις δυνατότητες να τρέχει ως γραμμή εντολών, μειώνει πολύ την εξάρτηση από οποιεσδήποτε προϋποθέσεις υπό τη μορφή κονσόλας ή εφαρμογής, δηλαδή η μόνη εξάρτηση που έχει ο Newman είναι ένας κόμβος (ο οποίος είναι γενικά διαθέσιμος ως εκτέλεση περιβάλλον σε όλες τις μηχανές CI, όπως οι σκλάβοι Jenkins ή οι κόμβοι Travis).
Αυτό επιτρέπει στις συλλογές Postman να εκτελούνται ως μέρος των ίδιων των αγωγών κατασκευής μέσω της γραμμής εντολών Newman.
Με τον Newman να έχει δυνατότητες προώθησης αποτελεσμάτων και σε μορφή Html, αυτό είναι πραγματικά χρήσιμο και βολικό και κατά τη διάρκεια της ίδιας της εκτέλεσης του αγωγού, τα αποτελέσματα HTML θα μπορούσαν να προωθηθούν σε έναν διακομιστή ή μπορούν να σταλούν μέσω email στους επιθυμητούς χρήστες κ.λπ. Οι δυνατότητες είναι ατελείωτες καθώς οι εξαρτήσεις είναι ελάχιστες.
Για αναλυτικό παράδειγμα εκτέλεσης ολοκλήρωσης με Jenkins, ανατρέξτε σε αυτό το παράδειγμα από το επίσημο ιστολόγιο του Postman εδώ .
Περισσότερες επιλογές με τον Newman
Ό, τι καλύψαμε είναι ένα υποσύνολο της λειτουργικότητας που παρέχεται από τον Newman. Για πλήρεις λεπτομέρειες των εντολών και των διακοπτών που υποστηρίζει το Newman, απλώς ανοίξτε τη βοήθεια της γραμμής εντολών για το Newman χρησιμοποιώντας την παρακάτω εντολή.
newman run -hΕδώ είναι η έξοδος της παραπάνω εντολής, με λεπτομέρειες για όλους τους διακόπτες και τις έννοιες τους.
Υπάρχουν και άλλοι πόροι πληροφοριών για αναφορά στο Newman API. Παρακαλώ αναφερθείτε εδώ για την επίσημη τεκμηρίωση.
συμπέρασμα
Σε αυτό το σεμινάριο, περάσαμε από την ενοποίηση της γραμμής εντολών του Postman που ονομάζεται Newman, η οποία επιτρέπει την εκτέλεση συλλογών Postman μέσω μιας διεπαφής γραμμής εντολών.
Είναι απλώς ένα πακέτο κόμβων και οποιαδήποτε γραμμή εντολών έχει εγκατεστημένο τον κόμβο μαζί με το Newman θα πρέπει να μπορεί να εκτελεί τη συλλογή Postman και να δημιουργεί καλές αναφορές για την εκτέλεση της συλλογής.
Η ενσωμάτωση γραμμής εντολών είναι επίσης μεγάλη βοήθεια για την ενσωμάτωση δοκιμών συλλογής με βάση το Postman με εργαλεία CI όπως Jenkins, Travis κ.λπ., καθώς η εκτέλεση της γραμμής εντολών δεν έχει καμία εξάρτηση από το λειτουργικό σύστημα ή την εφαρμογή και απλά χρειάζεται απλώς περιβάλλον κόμβου για να εκτελέσει το συλλογή.
=> Επισκεφτείτε εδώ για την αποκλειστική σειρά εκπαιδευτικών ταχυδρόμων Postman.
Συνιστώμενη ανάγνωση
- Αποκοπή εντολής στο Unix με παραδείγματα
- Unix Cat Command Syntax, Επιλογές με παραδείγματα
- Ls Command στο Unix με παραδείγματα
- Πώς και πότε να χρησιμοποιηθούν τα σενάρια προαίρεσης και ανάρτησης του ταχυδρόμου;
- Εντολή Grep στο Unix με απλά παραδείγματα
- Επιχειρήματα γραμμής εντολών στο C ++
- Unix Sort Command με Σύνταξη, Επιλογές και Παραδείγματα
- Επιχειρήματα γραμμής εντολών στο Unix Shell Script με παράδειγμα