From f6f2cb707062019adaaa12f7c499385ebff33fb9 Mon Sep 17 00:00:00 2001
From: Darin Kelkhoff <darin.kelkhoff@gmail.com>
Date: Thu, 30 Mar 2023 11:53:11 -0500
Subject: [PATCH] Fix test (good catch - 200 for GET /api/, and 404 for bad
 version doc pages)

---
 .../actions/GenerateOpenApiSpecAction.java    |  4 ++++
 .../qqq/api/javalin/QJavalinApiHandler.java   | 24 +++++++++++++++++++
 .../GenerateOpenApiSpecActionTest.java        | 14 +++++++++++
 .../api/javalin/QJavalinApiHandlerTest.java   | 15 ++++++++++--
 4 files changed, 55 insertions(+), 2 deletions(-)

diff --git a/qqq-middleware-api/src/main/java/com/kingsrook/qqq/api/actions/GenerateOpenApiSpecAction.java b/qqq-middleware-api/src/main/java/com/kingsrook/qqq/api/actions/GenerateOpenApiSpecAction.java
index c5254f7c..f3d29751 100644
--- a/qqq-middleware-api/src/main/java/com/kingsrook/qqq/api/actions/GenerateOpenApiSpecAction.java
+++ b/qqq-middleware-api/src/main/java/com/kingsrook/qqq/api/actions/GenerateOpenApiSpecAction.java
@@ -104,6 +104,10 @@ public class GenerateOpenApiSpecAction extends AbstractQActionFunction<GenerateO
       QInstance qInstance = QContext.getQInstance();
 
       ApiInstanceMetaData apiInstanceMetaData = ApiInstanceMetaData.of(qInstance);
+      if(!apiInstanceMetaData.getSupportedVersions().contains(new APIVersion(version)))
+      {
+         throw (new QException("[" + version + "] is not a supported API Version."));
+      }
 
       OpenAPI openAPI = new OpenAPI()
          .withVersion("3.0.3")
diff --git a/qqq-middleware-api/src/main/java/com/kingsrook/qqq/api/javalin/QJavalinApiHandler.java b/qqq-middleware-api/src/main/java/com/kingsrook/qqq/api/javalin/QJavalinApiHandler.java
index 4de91add..beb23468 100644
--- a/qqq-middleware-api/src/main/java/com/kingsrook/qqq/api/javalin/QJavalinApiHandler.java
+++ b/qqq-middleware-api/src/main/java/com/kingsrook/qqq/api/javalin/QJavalinApiHandler.java
@@ -482,6 +482,12 @@ public class QJavalinApiHandler
          QBrandingMetaData   branding            = qInstance.getBranding();
          ApiInstanceMetaData apiInstanceMetaData = ApiInstanceMetaData.of(qInstance);
 
+         if(!apiInstanceMetaData.getSupportedVersions().contains(new APIVersion(version)))
+         {
+            doPathNotFound(context);
+            return;
+         }
+
          //////////////////////////////////
          // read html from resource file //
          //////////////////////////////////
@@ -1634,6 +1640,24 @@ public class QJavalinApiHandler
    public static void respondWithError(Context context, HttpStatus.Code statusCode, String errorMessage)
    {
       context.status(statusCode.getCode());
+
+      try
+      {
+         String accept = context.header("accept");
+         if(accept != null && accept.toLowerCase().startsWith(ContentType.HTML))
+         {
+            context.contentType(ContentType.HTML);
+            context.result("Error: " + errorMessage);
+            return;
+         }
+      }
+      catch(Exception e)
+      {
+         ///////////////////////////
+         // just do default thing //
+         ///////////////////////////
+      }
+
       context.result(JsonUtils.toJson(Map.of("error", errorMessage)));
    }
 
diff --git a/qqq-middleware-api/src/test/java/com/kingsrook/qqq/api/actions/GenerateOpenApiSpecActionTest.java b/qqq-middleware-api/src/test/java/com/kingsrook/qqq/api/actions/GenerateOpenApiSpecActionTest.java
index 4ee2e258..51c8b949 100644
--- a/qqq-middleware-api/src/test/java/com/kingsrook/qqq/api/actions/GenerateOpenApiSpecActionTest.java
+++ b/qqq-middleware-api/src/test/java/com/kingsrook/qqq/api/actions/GenerateOpenApiSpecActionTest.java
@@ -36,6 +36,7 @@ import com.kingsrook.qqq.backend.core.model.metadata.fields.QFieldType;
 import com.kingsrook.qqq.backend.core.model.metadata.tables.Capability;
 import com.kingsrook.qqq.backend.core.model.metadata.tables.QTableMetaData;
 import org.junit.jupiter.api.Test;
+import static org.assertj.core.api.Assertions.assertThatThrownBy;
 import static org.junit.jupiter.api.Assertions.assertTrue;
 
 
@@ -158,4 +159,17 @@ class GenerateOpenApiSpecActionTest extends BaseTest
       assertTrue(apiPaths.stream().noneMatch(s -> s.contains("/internalName/")));
    }
 
+
+
+   /*******************************************************************************
+    **
+    *******************************************************************************/
+   @Test
+   void testBadVersion()
+   {
+      assertThatThrownBy(() -> new GenerateOpenApiSpecAction().execute(new GenerateOpenApiSpecInput().withVersion("NotAVersion")))
+         .isInstanceOf(QException.class)
+         .hasMessageContaining("not a supported API Version");
+   }
+
 }
\ No newline at end of file
diff --git a/qqq-middleware-api/src/test/java/com/kingsrook/qqq/api/javalin/QJavalinApiHandlerTest.java b/qqq-middleware-api/src/test/java/com/kingsrook/qqq/api/javalin/QJavalinApiHandlerTest.java
index c91d1483..f43f8159 100644
--- a/qqq-middleware-api/src/test/java/com/kingsrook/qqq/api/javalin/QJavalinApiHandlerTest.java
+++ b/qqq-middleware-api/src/test/java/com/kingsrook/qqq/api/javalin/QJavalinApiHandlerTest.java
@@ -147,9 +147,20 @@ class QJavalinApiHandlerTest extends BaseTest
       {
          assertErrorResponse(HttpStatus.NOT_FOUND_404, "Could not find any resources at path", Unirest.request(method, BASE_URL + "/api/" + VERSION + "/notATable/").asString());
          assertErrorResponse(HttpStatus.NOT_FOUND_404, "Could not find any resources at path", Unirest.request(method, BASE_URL + "/api/" + VERSION + "/notATable/notAnId").asString());
-         assertErrorResponse(HttpStatus.NOT_FOUND_404, "Could not find any resources at path", Unirest.request(method, BASE_URL + "/api/").asString());
-         assertErrorResponse(HttpStatus.NOT_FOUND_404, "Could not find any resources at path", Unirest.request(method, BASE_URL + "/api/foo").asString());
          assertErrorResponse(HttpStatus.NOT_FOUND_404, "Could not find any resources at path", Unirest.request(method, BASE_URL + "/api/" + VERSION + "/person/1/2").asString());
+         assertErrorResponse(HttpStatus.NOT_FOUND_404, "Could not find any resources at path", Unirest.request(method, BASE_URL + "/api/foo").asString());
+
+         if(method.equals("get"))
+         {
+            //////////////////////////////////////////////
+            // this path returns the doc site for a GET //
+            //////////////////////////////////////////////
+            assertErrorResponse(HttpStatus.OK_200, null, Unirest.request(method, BASE_URL + "/api/").asString());
+         }
+         else
+         {
+            assertErrorResponse(HttpStatus.NOT_FOUND_404, "Could not find any resources at path", Unirest.request(method, BASE_URL + "/api/").asString());
+         }
       }
    }