forked from hmrc/api-documentation-frontend
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* API-7064 - Changing how Redoc download button works * API-7065 - Adding tests for open api controller * API-7065 - PR Comments
- Loading branch information
1 parent
4b6eec7
commit 43f8745
Showing
11 changed files
with
246 additions
and
17 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
103 changes: 103 additions & 0 deletions
103
test/uk/gov/hmrc/apidocumentation/controllers/OpenApiDocumentationControllerSpec.scala
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,103 @@ | ||
| /* | ||
| * Copyright 2023 HM Revenue & Customs | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package uk.gov.hmrc.apidocumentation.controllers | ||
|
|
||
| import java.io.FileNotFoundException | ||
| import scala.concurrent.ExecutionContext.Implicits.global | ||
|
|
||
| import akka.actor.ActorSystem | ||
| import io.swagger.v3.oas.models.OpenAPI | ||
| import io.swagger.v3.parser.core.extensions.SwaggerParserExtension | ||
| import io.swagger.v3.parser.core.models.SwaggerParseResult | ||
|
|
||
| import play.api.http.Status.{NOT_FOUND, OK} | ||
| import play.api.mvc.MessagesControllerComponents | ||
| import play.api.test.Helpers._ | ||
|
|
||
| import uk.gov.hmrc.apidocumentation.ErrorHandler | ||
| import uk.gov.hmrc.apidocumentation.mocks.config._ | ||
| import uk.gov.hmrc.apidocumentation.mocks.connectors.DownloadConnectorMockModule | ||
| import uk.gov.hmrc.apidocumentation.mocks.services._ | ||
| import uk.gov.hmrc.apidocumentation.views.html._ | ||
|
|
||
| class OpenApiDocumentationControllerSpec extends CommonControllerBaseSpec { | ||
|
|
||
| trait Setup | ||
| extends DownloadConnectorMockModule | ||
| with ApiDefinitionServiceMock | ||
| with LoggedInUserServiceMock | ||
| with NavigationServiceMock | ||
| with AppConfigMock { | ||
|
|
||
| val emptySwaggerParseResult = new SwaggerParseResult() | ||
| val openApiSwaggerParseResult = new SwaggerParseResult() | ||
| openApiSwaggerParseResult.setOpenAPI(new OpenAPI()) | ||
|
|
||
| lazy val openApiViewRedoc = app.injector.instanceOf[OpenApiViewRedoc] | ||
| lazy val openApiPreviewRedoc = app.injector.instanceOf[OpenApiPreviewRedoc] | ||
| lazy val openApiPreviewView = app.injector.instanceOf[OpenApiPreviewView] | ||
| lazy val retiredVersionJumpView = app.injector.instanceOf[RetiredVersionJumpView] | ||
| lazy val mcc = app.injector.instanceOf[MessagesControllerComponents] | ||
| lazy val errorHandler = app.injector.instanceOf[ErrorHandler] | ||
| lazy val openAPIV3ParserMock = mock[SwaggerParserExtension] | ||
|
|
||
| implicit lazy val system = app.injector.instanceOf[ActorSystem] | ||
|
|
||
| val underTest = new OpenApiDocumentationController( | ||
| openApiViewRedoc, | ||
| openApiPreviewRedoc, | ||
| openApiPreviewView, | ||
| retiredVersionJumpView, | ||
| DownloadConnectorMock.aMock, | ||
| mcc, | ||
| apiDefinitionService, | ||
| loggedInUserService, | ||
| errorHandler, | ||
| navigationService, | ||
| openAPIV3ParserMock | ||
| ) | ||
| } | ||
|
|
||
| "OpenApiDocumentationController" should { | ||
| "successfully fetch resolved OAS specification" in new Setup { | ||
| when(appConfig.oasFetchResolvedMaxDuration).thenReturn(1000) | ||
| when(openAPIV3ParserMock.readLocation(*, *, *)).thenReturn(openApiSwaggerParseResult) | ||
|
|
||
| val result = underTest.fetchOasResolved("Test-Service", "Test-Version")(request) | ||
|
|
||
| status(result) shouldBe OK | ||
| } | ||
|
|
||
| "successfully handle and error when fetching resolved OAS specification" in new Setup { | ||
| when(appConfig.oasFetchResolvedMaxDuration).thenReturn(1000) | ||
| when(openAPIV3ParserMock.readLocation(*, *, *)).thenReturn(emptySwaggerParseResult) | ||
|
|
||
| val result = underTest.fetchOasResolved("Test-Service", "Test-Version")(request) | ||
|
|
||
| status(result) shouldBe NOT_FOUND | ||
| } | ||
|
|
||
| "successfully handle FileNotFoundException when fetching resolved OAS specification" in new Setup { | ||
| when(appConfig.oasFetchResolvedMaxDuration).thenReturn(1000) | ||
| when(openAPIV3ParserMock.readLocation(*, *, *)).thenThrow(new FileNotFoundException()) | ||
|
|
||
| val result = underTest.fetchOasResolved("Test-Service", "Test-Version")(request) | ||
|
|
||
| status(result) shouldBe NOT_FOUND | ||
| } | ||
| } | ||
| } |
41 changes: 41 additions & 0 deletions
41
test/uk/gov/hmrc/apidocumentation/mocks/connectors/DownloadConnectorMockModule.scala
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| /* | ||
| * Copyright 2023 HM Revenue & Customs | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package uk.gov.hmrc.apidocumentation.mocks.connectors | ||
|
|
||
| import scala.concurrent.Future.successful | ||
|
|
||
| import org.mockito.{ArgumentMatchersSugar, MockitoSugar} | ||
|
|
||
| import uk.gov.hmrc.apidocumentation.connectors.DownloadConnector | ||
|
|
||
| trait DownloadConnectorMockModule extends MockitoSugar with ArgumentMatchersSugar { | ||
|
|
||
| trait AbstractDownloadConnectorMock { | ||
| def aMock: DownloadConnector | ||
|
|
||
| object Fetch { | ||
|
|
||
| def returnsNoneIfNotFound() = { | ||
| when(aMock.fetch(*, *, *)).thenReturn(successful(None)) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| object DownloadConnectorMock extends AbstractDownloadConnectorMock { | ||
| val aMock = mock[DownloadConnector] | ||
| } | ||
| } |