Swagger plugins support

[jvmlet]

Pull Request

The issue or feature being addressed

Closes #3049

[martincostello]

Please add tests.

[martincostello]

I also don't see tests for request/response interceptors.

Swashbuckle.AspNetCore/test/Swashbuckle.AspNetCore.IntegrationTests/SwaggerUIIntegrationTests.cs

Lines 100 to 110 in d7a92a1

	[Fact]
	public async Task IndexUrl_ReturnsInterceptors_IfConfigured()
	{
	var client = new TestSite(typeof(CustomUIConfig.Startup)).BuildClient();
	var response = await client.GetAsync("/swagger/index.js");
	var content = await response.Content.ReadAsStringAsync();
	Assert.Contains("\"RequestInterceptorFunction\":", content);
	Assert.Contains("\"ResponseInterceptorFunction\":", content);
	}

[jvmlet]

Please add tests.

There is no infrastructure in integration tests to evaluate the index.html in browser (like Selenium) and I also don't see tests for request/response interceptors.

[martincostello]

#3056 (comment)

We don't test with Selenium, we test that the desired rendering effect is in the HTML as in the examples of existing tests I've directed you to.

[jvmlet]

I also don't see tests for request/response interceptors.

Swashbuckle.AspNetCore/test/Swashbuckle.AspNetCore.IntegrationTests/SwaggerUIIntegrationTests.cs

Lines 100 to 110 in d7a92a1

	[Fact]
	public async Task IndexUrl_ReturnsInterceptors_IfConfigured()
	{
	var client = new TestSite(typeof(CustomUIConfig.Startup)).BuildClient();
	var response = await client.GetAsync("/swagger/index.js");
	var content = await response.Content.ReadAsStringAsync();
	Assert.Contains("\"RequestInterceptorFunction\":", content);
	Assert.Contains("\"ResponseInterceptorFunction\":", content);
	}

Great, I would expect to see test that actually asserts the js function functionality , not the template. With plugins it always there ....

[martincostello]

I would expect to see test that actually asserts the js function functionality

That would be testing swagger-ui itself, which isn't our code.

[jvmlet]

I would expect to see test that actually asserts the js function functionality

That would be testing swagger-ui itself, which isn't our code.

Then how do you suggest to test this line ? Without Selenium I can't assert that the plugin was loaded ...

[martincostello]

Then how do you suggest to test this line ? Without Selenium I can't assert that the plugin was loaded ...

Do what the tests I already directed you to do - check that the text of the configured plugins is in the rendered document.

[jvmlet]

Please add tests.

added

[codecov-commenter]

⚠️ Please install the to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.53%. Comparing base (90f302d) to head (b7b55d4).
Report is 13 commits behind head on master.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #3056      +/-   ##
==========================================
+ Coverage   90.49%   90.53%   +0.03%     
==========================================
  Files          76       76              
  Lines        3063     3095      +32     
  Branches      496      504       +8     
==========================================
+ Hits         2772     2802      +30     
- Misses        291      293       +2     

Flag	Coverage Δ
Linux	90.53% <100.00%> (+0.03%)	⬆️
Windows	90.53% <100.00%> (+0.03%)	⬆️
macOS	90.53% <100.00%> (+0.03%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[AkselKP]

@jvmlet Did you test this "manually"? It looks like the plugins code is executed twice...? Is this behavior within swagger-ui and out of our control?
Using your example:

FYI @martincostello

[jvmlet]

This is what swagger-ui does ... Not in the app's control.
@martincostello , when do you plan to release next version ?

[martincostello]

#3060 (comment)

[martincostello]

Can someone confirm whether or not the double execution is an issue or not? I don't want to publish 6.8.0 if it turns out there's a bug with this we need to fix.

[jvmlet]

This is not double execution , this is double instantiation.
This is what swagger-ui does, regardless of the source definition of the plugin (swashbuckle or end-user manual code writing ....)