WireMock-Net / WireMock.Net

WireMock.Net is a flexible product for stubbing and mocking web HTTP responses using advanced request matching and response templating. Based on the functionality from http://WireMock.org, but extended with more functionality.
Apache License 2.0
1.36k stars 199 forks source link

GetAdminMappingsResult in WireMock.Org.Abstractions should contain list of mappings #1021

Closed roengstrom closed 7 months ago

roengstrom commented 7 months ago

Describe the bug

When running a dedicated instance of Wiremock in a docker container I cannot fetch the configured mappings. It seems like GetAdminMappingsResult expects an instance of Mappings but according to the Wiremock API documentation, this should not be an object but an array. So when I call the method I get an exception:

   Newtonsoft.Json.JsonSerializationException : Cannot deserialize the current JSON array (e.g. [1,2,3]) into type 'WireMock.Org.Abstractions.Mappings' because the type requires a JSON object (e.g. {"name":"value"}) to deserialize correctly.
To fix this error either change the JSON to a JSON object (e.g. {"name":"value"}) or change the deserialized type to an array or a type that implements a collection interface (e.g. ICollection, IList) like List<T> that can be deserialized from a JSON array. JsonArrayAttribute can also be added to the type to force it to deserialize from a JSON array.
Path 'mappings', line 2, position 16.
  Stack Trace:
     at Newtonsoft.Json.Serialization.JsonSerializerInternalReader.EnsureArrayContract(JsonReader reader, Type objectType, JsonContract contract)
   at Newtonsoft.Json.Serialization.JsonSerializerInternalReader.CreateList(JsonReader reader, Type objectType, JsonContract contract, JsonProperty member, Object existingValue, String id)
   at Newtonsoft.Json.Serialization.JsonSerializerInternalReader.CreateValueInternal(JsonReader reader, Type objectType, JsonContract contract, JsonProperty member, JsonContainerContract containerContract, JsonProperty containerMember, Object existingValue)
   at Newtonsoft.Json.Serialization.JsonSerializerInternalReader.SetPropertyValue(JsonProperty property, JsonConverter propertyConverter, JsonContainerContract containerContract, JsonProperty containerProperty, JsonReader reader, Object target)
   at Newtonsoft.Json.Serialization.JsonSerializerInternalReader.PopulateObject(Object newObject, JsonReader reader, JsonObjectContract contract, JsonProperty member, String id)
   at Newtonsoft.Json.Serialization.JsonSerializerInternalReader.CreateObject(JsonReader reader, Type objectType, JsonContract contract, JsonProperty member, JsonContainerContract containerContract, JsonProperty containerMember, Object existingValue)
   at Newtonsoft.Json.Serialization.JsonSerializerInternalReader.CreateValueInternal(JsonReader reader, Type objectType, JsonContract contract, JsonProperty member, JsonContainerContract containerContract, JsonProperty containerMember, Object existingValue)
   at Newtonsoft.Json.Serialization.JsonSerializerInternalReader.Deserialize(JsonReader reader, Type objectType, Boolean checkAdditionalContent)
   at Newtonsoft.Json.JsonSerializer.DeserializeInternal(JsonReader reader, Type objectType)
   at Newtonsoft.Json.JsonConvert.DeserializeObject(String value, Type type, JsonSerializerSettings settings)
   at Newtonsoft.Json.JsonConvert.DeserializeObject[T](String value, JsonSerializerSettings settings)
   at RestEase.JsonResponseDeserializer.Deserialize[T](String content, HttpResponseMessage response, ResponseDeserializerInfo info)
   at RestEase.Implementation.Requester.Deserialize[T](String content, HttpResponseMessage response, IRequestInfo requestInfo)
   at RestEase.Implementation.Requester.RequestAsync[T](IRequestInfo requestInfo)

Expected behavior:

I expect to not get an exception and instead get an instance of GetAdminMappingsResult containing a list of mappings.

Test to reproduce

var wireMockBaseUrl = "http://localhost:8080";
var client = RestClient.For<IWireMockOrgApi>(wireMockBaseUrl);
await client.GetAdminMappingsAsync(null, null);
StefH commented 7 months ago

https://github.com/WireMock-Net/WireMock.Net/pull/1023

StefH commented 7 months ago

@roengstrom Please note that this API is not 100% guaranteed to be compatible with the WireMock.Org version, however I did change the code, can you please test preview 1.5.40-ci-17965 ?

https://github.com/WireMock-Net/WireMock.Net/wiki/MyGet-preview-versions

roengstrom commented 7 months ago

@StefH I tested it out and fetching the mappings works fine now, nice work!

Is the idea of this client that it should be fully compatible with standalone Wiremock instances? Because like you mention, there's no guarantee that it works, and indeed I've encountered other issues as well unfortunately. But if the intention is for it to be fully compatible it would be nice to get it working, because as far as I can tell, there doesn't seem to exist any dotnet client for standalone Wiremock.

StefH commented 7 months ago

@roengstrom

In the beginning I used the openapi-specification from WireMock.Org to generate the classes + api (I was trying to use https://github.com/StefH/RestEase-Client-Generator).

And then I did have to update some code manually to get it working.


If it's not too much work, I can try to build a 100% working .NET client, however I need to some and some help from the community for that. (I will also reach out to WireMock.Org)


So if you find other issues, please list these here, or create a PR.

roengstrom commented 7 months ago

@StefH I'll see if I can make time and create a PR. :) Thank you

StefH commented 7 months ago

@StefH I'll see if I can make time and create a PR. :) Thank you

Do you want to continue your PR on from my branch/PR or should I merge my PR to master so that you can fork and make your own branch?

roengstrom commented 7 months ago

@StefH I'm thinking you can merge and I'll work from master in that case.

StefH commented 7 months ago

It's merged.