consumer.h

Go to the documentation of this file.

#pragma once
 
#include <string>
#include <unordered_map>
#include <vector>
#include <pact.h>
#include <filesystem>
#include <optional>
#include <functional>
#include "matchers.h"
 
namespace pact_consumer {
 
  void init();
 
  class Interaction;
 
  class MockServerHandle {
    public:
      MockServerHandle(PactHandle);
      ~MockServerHandle();
 
      bool started_ok() const;
 
      std::string get_url() const;
 
      int32_t get_port() const;
 
    private:
      int32_t port;
  };
 
  enum TestResultState { 
    Mismatches        = (1u << 0),
    UserCodeFailed    = (1u << 1),
    PactFileError     = (1u << 2),
    MockServerFailed  = (1u << 3)
  };
 
  class PactTestResult {
    public:
      PactTestResult();
 
      void add_state(TestResultState state);
 
      void add_state(TestResultState state, std::string message);
 
      void add_state(TestResultState state, std::string message, std::string ex);
 
      bool is_ok() const;
 
      void display_errors();
 
    private:
      unsigned int status = 0;
      std::vector<std::string> messages;
      std::optional<std::string> ex;
  };
 
  class Pact {
    public:
      Pact(const char* consumer, const char* provider);
 
      Interaction given(const char* provider_state) const;
 
      Interaction given(const char* provider_state, const std::unordered_map<std::string, std::string>& parameters) const;
 
      Interaction uponReceiving(const char* description) const;
 
      PactTestResult run_test(std::function<bool(const MockServerHandle*)> callback) const;
 
      PactHandle pact;
 
      std::string pact_directory;
 
    private:
      std::string consumer;
      std::string provider;
  };
 
  class Interaction {
    public:
    Interaction(const Pact* parent, const char *description);
 
    Interaction given(const char* provider_state) const;
 
    Interaction given(const char* provider_state, const std::unordered_map<std::string, std::string>& parameters) const;
 
    Interaction uponReceiving(const char* description) const;
 
    Interaction withRequest(const char* method, const char* path) const;
 
    Interaction withQuery(const std::unordered_map<std::string, std::vector<std::string>>& query) const;
 
    Interaction withHeaders(const std::unordered_map<std::string, std::vector<std::string>>& headers) const;
    
    Interaction withBody(const std::string& body, const std::string& content_type) const;
 
    Interaction withJsonBody(pact_consumer::matchers::IMatcher::Ptr body) const;
 
    Interaction withBinaryFile(const std::string& content_type, const std::filesystem::path& example_file) const;
 
    Interaction withMultipartFileUpload(const std::string& part_name, const std::string& content_type, const std::filesystem::path& example_file) const;
 
    Interaction willRespondWith(size_t status) const;
 
    Interaction withResponseHeaders(const std::unordered_map<std::string, std::vector<std::string>>& headers) const;
 
    Interaction withResponseBody(const std::string& body, const std::string& content_type) const;
 
    Interaction withResponseJsonBody(pact_consumer::matchers::IMatcher::Ptr body) const;
 
    Interaction withResponseBinaryFile(const std::string& content_type, const std::filesystem::path& example_file) const;
 
    Interaction withResponseMultipartFileUpload(const std::string& part_name, const std::string& content_type, const std::filesystem::path& example_file) const;
 
    InteractionHandle interaction;
 
    private:
      std::string description;
      const Pact* pact;
  };
}