how publish pact contract pact broker
Αυτό το σεμινάριο εξηγεί δύο επιλογές για τη δημιουργία του Pact Broker. Μπορείτε να δημοσιεύσετε τη Σύμβαση Συμφωνίας στο Pact Broker χρησιμοποιώντας το πλαίσιο pact-js και με τον Postman:
δωρεάν μετατροπέας youtube σε mp4 δωρεάν χωρίς λήψη
Τι είναι το Pact Broker;
Το Pact Broker είναι ένα εργαλείο που παρέχεται από τους δημιουργούς του Pact framework. Διευκολύνει την αποθήκευση συμβάσεων, την οπτικοποίηση των καταναλωτών και την κατάσταση της σύμβασης επαλήθευσης.
Ο λόγος για την ύπαρξη ξεχωριστού μεσίτη για την αποθήκευση των συμβολαίων είναι επειδή κάθε σύνολο δοκιμών γράφεται συχνά σε διαφορετικά αποθετήρια και ακόμη και σε διαφορετικές γλώσσες.
=> Εξερευνήστε τη σειρά εκπαιδευτικών δοκιμών απλής σύμβασης εδώ
Τι θα μάθετε:
Δημοσίευση συμβολαίου Pact to Pact Broker
Πριν προχωρήσουμε στο πώς να δημοσιεύσουμε ένα συμβόλαιο, πρέπει να αποφασίσετε εάν θέλετε να φιλοξενήσετε τον Pact Broker μόνοι σας ή να χρησιμοποιήσετε μια φιλοξενούμενη υπηρεσία όπως Ροή .
Προσωπικά, επιλέξαμε το Pactflow καθώς προσφέρει τα πρόσθετα οφέλη όπως φαίνεται στον παρακάτω πίνακα:
χαρακτηριστικό | Ροή | Αυτο-φιλοξενείται |
---|---|---|
SSO (Github) | Ναί | Μην |
Συντήρηση του διακομιστή | Μην | Ναί |
Ασφαλείς μάρκες / μυστικά | Ναί | Μην |
Webhooks | Διαμόρφωση UI | Μη αυτόματη διαμόρφωση |
Υποδομή ως Κώδικας | Τεραφόρμ | Dockerfile |
Ρύθμιση Pact Broker με Pactflow
Ροή παρέχει μια δωρεάν επιλογή που θα σας χρεώσει μόνο μετά τη δοκιμή των 180 μηνών (από τον Μάιο του 2020), δηλαδή ενάμισι χρόνια.
- Καταχωρήστε τη διεύθυνση email σας στο Pactflow (σημειώστε ότι μπορείτε πάντα να προσθέσετε επιπλέον χρήστες αργότερα).
- Ρυθμίστε τις πληροφορίες της εταιρείας και τον υποτομέα για το Pact Broker.
- Θα πρέπει τώρα να λάβετε ένα e-mail με το προσωρινό όνομα χρήστη και τον κωδικό πρόσβασής σας.
- Πλοηγηθείτε στον υποτομέα σας, (εδώ είναι το δικό μου υποτομέας ) και συνδεθείτε. Εάν αυτό ήταν επιτυχές, θα πρέπει να δείτε το παράδειγμα εφαρμογής με ένα συμβόλαιο που έχει ήδη ρυθμιστεί.
Θα δούμε πώς θα επαληθεύσουμε τις συμβάσεις στο Pactflow αργότερα στο σεμινάριο.
Ρύθμιση του Pact Broker With Docker (docker-compose)
Το Pact προσφέρει εικόνες λιμενεργάτη για εύκολη περιστροφή του δικού σας Pact Broker σε δευτερόλεπτα με σύνθετο. ο αποθετήριο github εξηγεί πώς μπορεί να γίνει αυτό, ας το αναλύσουμε αργότερα.
Μερικά επιπλέον βήματα που προστίθενται για να διασφαλιστεί ότι η υπηρεσία είναι σταθερή δίνονται παρακάτω:
- Προσθέστε 'επανεκκίνηση: πάντα' στο λιμενεργάτης Υπηρεσίες.
- Εκκινήστε το docker-compose στο διακομιστή χρησιμοποιώντας το ανεξάρτητο όρισμα '-d' για να επιτρέψετε την εκτέλεση στο παρασκήνιο.
Έκδοση συμβολαίου με σύμφωνο-js
Κάθε εφαρμογή γλώσσας του Συμφώνου έχει τις δικές της μεθόδους για το πώς να δημοσιεύσει τα συμβόλαια στον μεσίτη. Δημοσιεύοντας στο Pact Broker σε JavaScript, η διαμόρφωση θα πρέπει να μοιάζει με αυτήν.
Το Pact Broker Token που εμφανίζεται παραπάνω αποθηκεύεται στο Pactflow κάτω από τις ρυθμίσεις. Τα στιγμιότυπα οθόνης εμφανίζονται παρακάτω. Βεβαιωθείτε ότι χρησιμοποιείτε το διακριτικό CI που έχει δικαιώματα ανάγνωσης και γραφής.
Παω σε Ρυθμίσεις και έπειτα Διακριτικά API στο Pactflow.
Πιθανώς τα μυστικά και οι κωδικοί πρόσβασης δεν πρέπει να αποθηκεύονται στο git, επομένως ένα αρχείο «.env` πρέπει να χρησιμοποιείται και να αναφέρεται στον κώδικα με κάτι όπως φαίνεται παρακάτω.
Μαζί με 'PublishVerificationResult' αξία, δεν θέλετε να επαληθεύετε συμβόλαια στο τοπικό σας περιβάλλον. Επομένως, πρέπει να οριστεί μια άλλη μεταβλητή περιβάλλοντος, όπως φαίνεται παρακάτω.
Τώρα το συμβόλαιο μπορεί να δημοσιευτεί απευθείας στον κώδικα.
Έκδοση συμβολαίου με ταχυδρόμο
Συνήθως, για την επαλήθευση του πρώτου συμβολαίου, χρησιμοποιούμε τον Postman για να διασφαλίσουμε ότι ο μεσίτης έχει ρυθμιστεί σωστά. Ταχυδρόμος χρησιμοποιήθηκε επίσης όταν οι καταναλωτές αργούσαν να υιοθετήσουν το Σύμφωνο στην ομάδα τους, οπότε δημοσιεύσαμε το συμβόλαιο στο Pact Broker και ζητήσαμε από την ομάδα καταναλωτών να επαληθεύσει εάν είναι ικανοποιημένοι με τη σύμβαση.
Αυτό μας επέτρεψε ως ομάδα παρόχων να επαληθεύσουμε κατά τη σύμβαση και να έχουμε μεγαλύτερη εμπιστοσύνη στις υλοποιήσεις μας. Επίσης, όταν η ομάδα καταναλωτών ήταν έτοιμη να υιοθετήσει το Σύμφωνο, είχαν ήδη ένα λειτουργικό παράδειγμα για χρήση.
Τα βήματα για τη δημοσίευση του Postman δίνονται παρακάτω:
# 1) PUT: Κατασκευάστε το αίτημα
- Μεταβείτε στο υποτομέας
- Ονομα πάροχου
- Όνομα καταναλωτή
- Εκδοχή
# 2) Εξουσιοδότηση: Προσθέστε το διακριτικό κομιστή (το οποίο είναι ισοδύναμο με το διακριτικό API όπως αναφέρεται παραπάνω)
# 3) Συμπεριλάβετε το Pact JSON ως σώμα (το JSON μπορεί να αντιγραφεί απευθείας στο πεδίο του σώματος, διασφαλίζοντας έτσι τη ρύθμιση της κεφαλίδας Content: Type σε 'application / json').
Κοινή χρήση συμφωνιών με παρόχους API
Μετά τη δημοσίευση των συμβολαίων σας, ο πάροχος μπορεί να ανακτήσει τη σύμβαση Συμφωνίας ζητώντας τη διεύθυνση URL του Pact Broker με:
Συνήθως, θέλετε να επαληθεύσετε με μια συγκεκριμένη έκδοση του API. Για παράδειγμα, Σε μια αρχιτεκτονική μικροϋπηρεσιών, η ομάδα καταναλωτών κάνει συνεχώς αλλαγές στις πληροφορίες που απαιτούνται από το API.
Παράλληλα, ο πάροχος API πραγματοποιεί αλλαγές ταυτόχρονα και θα πρέπει να επαληθεύσει την έκδοση που χρησιμοποιείται αυτήν τη στιγμή στην παραγωγή, καθώς αυτό θα διασφαλίσει την απρόσκοπτη ανάπτυξη.
συμπέρασμα
Τέλος, έχετε ένα Pact Broker με δημοσιευμένο συμβόλαιο, στο επόμενο σεμινάριο θα εξετάσουμε πώς να γράψετε το τεστ παροχέα σας, τυλίγοντας ένα .Net Core API, τραβώντας το πιο πρόσφατο συμβόλαιο και επαληθεύοντας το τοπικό API.
Το πλαίσιο του Συμφώνου δεν είναι μόνο πολύτιμο στην αρχή του έργου σας, με γνώμονα τον καταναλωτή, αλλά το όφελος της οπτικοποίησης των καταναλωτών σας με το Pact Broker είναι σίγουρα βασικός συντελεστής στη χρήση αυτού του εργαλείου.
Επίσης, η ικανότητα καλύτερης κατανόησης των αλληλεπιδράσεων με τους καταναλωτές και του τρόπου με τον οποίο χρησιμοποιείται πραγματικά το API μπορεί συχνά να χαθεί στη μετάφραση και μπορεί να οδηγήσει σε ένα ζήτημα παραγωγής που μπορεί να συμβεί. Αυτό οδηγεί σε ώρες εντοπισμού σφαλμάτων και τράτας μέσω των αρχείων καταγραφής εφαρμογών.
Σε αυτό το σεμινάριο, μάθαμε δύο διαφορετικές επιλογές για να δημιουργήσουμε το Pact Broker. Έχετε δημοσιεύσει τη σύμβασή σας χρησιμοποιώντας το πλαίσιο pact-js και επίσης με τον Postman.
Σε αυτό το σημείο, πρέπει να σκεφτείτε να ευθυγραμμίσετε τις εκδόσεις σας μεταξύ των μικροϋπηρεσιών και επίσης να ονομάσετε τους παρόχους σας με συνέπεια για να δημιουργήσετε ένα ευανάγνωστο και κατανοητό δίκτυο Pact Broker.
=> Επισκεφθείτε εδώ για να μάθετε τη δοκιμή συμβολαίου από το μηδέν
Συνιστώμενη ανάγνωση
- Πώς να γράψετε μια δοκιμαστική συμφωνία καταναλωτή σε JavaScript
- Εισαγωγή στη δοκιμή συμβολαίου με παραδείγματα
- Επαληθεύστε τη Σύμβαση Συμφώνου και τη Συνεχή Ανάπτυξη με το Σύμφωνο CLI
- Docker Tutorial: Εγκατάσταση και εισαγωγή στο Docker
- Προηγμένο σενάριο για σύνθετες ροές εργασιών δοκιμών στον Ταχυδρόμο
- Πώς να δημιουργήσετε τεκμηρίωση API στον Ταχυδρόμο;
- Πώς να χρησιμοποιήσετε τον ταχυδρόμο για τη δοκιμή διαφορετικών μορφών API;
- Οι 10 πιο δημοφιλείς ερωτήσεις συνέντευξης Postman με απαντήσεις