Class: Sbmt::Pact::Consumer::GrpcInteractionBuilder

Inherits:
Object
  • Object
show all
Defined in:
lib/sbmt/pact/consumer/grpc_interaction_builder.rb

Defined Under Namespace

Classes: CreateInteractionError, InteractionBuilderError, InteractionMismatchesError, PluginInitError

Constant Summary collapse

DESCRIPTION_PREFIX = 
"grpc: "
CONTENT_TYPE = 
"application/protobuf"
GRPC_CONTENT_TYPE = 
"application/grpc"
PROTOBUF_PLUGIN_NAME = 
"protobuf"
PROTOBUF_PLUGIN_VERSION =

see .gitlab-ci.yml before changing plugin version

"0.4.0"
INIT_PLUGIN_ERRORS =

docs.rs/pact_ffi/0.4.17/pact_ffi/plugins/fn.pactffi_using_plugin.html

{
  1 => {reason: :internal_error, status: 1, description: "A general panic was caught"},
  2 => {reason: :plugin_load_failed, status: 2, description: "Failed to load the plugin"},
  3 => {reason: :invalid_handle, status: 3, description: "Pact Handle is not valid"}
}.freeze
CREATE_INTERACTION_ERRORS =

docs.rs/pact_ffi/0.4.17/pact_ffi/plugins/fn.pactffi_interaction_contents.html

{
  1 => {reason: :internal_error, status: 1, description: "A general panic was caught"},
  2 => {reason: :mock_server_already_running, status: 2, description: "The mock server has already been started"},
  3 => {reason: :invalid_handle, status: 3, description: "The interaction handle is invalid"},
  4 => {reason: :invalid_content_type, status: 4, description: "The content type is not valid"},
  5 => {reason: :invalid_contents, status: 5, description: "The contents JSON is not valid JSON"},
  6 => {reason: :plugin_error, status: 6, description: "The plugin returned an error"}
}.freeze

Instance Method Summary collapse

Constructor Details

#initialize(pact_config, description: nil) ⇒ GrpcInteractionBuilder

Returns a new instance of GrpcInteractionBuilder.



44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/sbmt/pact/consumer/grpc_interaction_builder.rb', line 44

def initialize(pact_config, description: nil)
  @pact_config = pact_config
  @description = description || ""

  @proto_path = nil
  @proto_include_dirs = []
  @service_name = nil
  @method_name = nil
  @request = nil
  @response = nil
  @response_meta = nil
  @provider_state_meta = nil
end

Instance Method Details

#execute(&block) ⇒ Object 



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/sbmt/pact/consumer/grpc_interaction_builder.rb', line 122

def execute(&block)
  raise InteractionBuilderError.new("interaction is designed to be used one-time only") if defined?(@used)

  validate!

  pact_handle = init_pact
  init_plugin!(pact_handle)

  message_pact = PactFfi::SyncMessageConsumer.new_interaction(pact_handle, description)
  @provider_state_meta&.each_pair do |provider_state, meta|
    if meta.present?
      meta.each_pair { |k, v| PactFfi.given_with_param(message_pact, provider_state, k.to_s, v.to_s) }
    else
      PactFfi.given(message_pact, provider_state)
    end
  end

  result = PactFfi::PluginConsumer.interaction_contents(message_pact, 0, GRPC_CONTENT_TYPE, interaction_json)
  if CREATE_INTERACTION_ERRORS[result].present?
    error = CREATE_INTERACTION_ERRORS[result]
    raise CreateInteractionError.new("There was an error while trying to add interaction \"#{description}\"", error[:reason], error[:status])
  end

  mock_server = MockServer.create_for_grpc!(pact: pact_handle, host: @pact_config.mock_host, port: @pact_config.mock_port)

  yield(message_pact, mock_server)

  if mock_server.matched?
    mock_server.write_pacts!(@pact_config.pact_dir)
  else
    msg = mismatches_error_msg(mock_server)
    raise InteractionMismatchesError.new(msg)
  end
ensure
  @used = true
  mock_server&.cleanup
  PactFfi::PluginConsumer.cleanup_plugins(pact_handle)
  PactFfi.free_pact_handle(pact_handle)
end

#given(provider_state, metadata = {}) ⇒ Object 



75
76
77
78
 
# File 'lib/sbmt/pact/consumer/grpc_interaction_builder.rb', line 75

def given(provider_state, metadata = {})
  @provider_state_meta = {provider_state => metadata}
  self
end

#interaction_json ⇒ Object 



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/sbmt/pact/consumer/grpc_interaction_builder.rb', line 100

def interaction_json
  result = {
    "pact:proto": @proto_path,
    "pact:proto-service": "#{@service_name}/#{@method_name}",
    "pact:content-type": CONTENT_TYPE,
    request: @request
  }

  result["pact:protobuf-config"] = {additionalIncludes: @proto_include_dirs} if @proto_include_dirs.present?

  result[:response] = @response if @response.is_a?(Hash)
  result[:responseMetadata] = @response_meta if @response_meta.is_a?(Hash)

  JSON.dump(result)
end

#upon_receiving(description) ⇒ Object 



80
81
82
83
 
# File 'lib/sbmt/pact/consumer/grpc_interaction_builder.rb', line 80

def upon_receiving(description)
  @description = description
  self
end

#validate! ⇒ Object

Raises:



116
117
118
119
120
 
# File 'lib/sbmt/pact/consumer/grpc_interaction_builder.rb', line 116

def validate!
  raise InteractionBuilderError.new("uninitialized service params, use #with_service to configure") if @proto_path.blank? || @service_name.blank? || @method_name.blank?
  raise InteractionBuilderError.new("invalid request format, should be a hash") unless @request.is_a?(Hash)
  raise InteractionBuilderError.new("invalid response format, should be a hash") unless @response.is_a?(Hash) || @response_meta.is_a?(Hash)
end

#with_request(req_hash) ⇒ Object 



85
86
87
88
 
# File 'lib/sbmt/pact/consumer/grpc_interaction_builder.rb', line 85

def with_request(req_hash)
  @request = InteractionContents.plugin(req_hash)
  self
end

#with_response(resp_hash) ⇒ Object 



90
91
92
93
 
# File 'lib/sbmt/pact/consumer/grpc_interaction_builder.rb', line 90

def with_response(resp_hash)
  @response = InteractionContents.plugin(resp_hash)
  self
end

#with_response_meta(meta_hash) ⇒ Object 



95
96
97
98
 
# File 'lib/sbmt/pact/consumer/grpc_interaction_builder.rb', line 95

def with_response_meta(meta_hash)
  @response_meta = InteractionContents.plugin(meta_hash)
  self
end

#with_service(proto_path, method, include_dirs = []) ⇒ Object

Raises:



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/sbmt/pact/consumer/grpc_interaction_builder.rb', line 58

def with_service(proto_path, method, include_dirs = [])
  raise InteractionBuilderError.new("invalid grpc method: cannot be blank") if method.blank?

  service_name, method_name = method.split("/") || []
  raise InteractionBuilderError.new("invalid grpc method: #{method}, should be like service/SomeMethod") if service_name.blank? || method_name.blank?

  absolute_path = File.expand_path(proto_path)
  raise InteractionBuilderError.new("proto file #{proto_path} does not exist") unless File.exist?(absolute_path)

  @proto_path = absolute_path
  @service_name = service_name
  @method_name = method_name
  @proto_include_dirs = include_dirs.map { |dir| File.expand_path(dir) }

  self
end