Merge pull request #6 from electronicarts/tehzhed-bump-finagle-swagger

Bump Finagle to 20.10.0; Bump Swagger UI to 3.38.0; Improve test coverage

.github/workflows/scala.yml

@@ -13,10 +13,10 @@ jobs:
 
     steps:
     - uses: actions/checkout@v2
-    - name: Set up JDK 1.8
+    - name: Set up JDK 11
       uses: actions/setup-java@v1
       with:
-        java-version: 1.8
+        java-version: 1.11
     - name: Run tests
       run: sbt -Dkara.isSnapshot=true coverage test scripted coverageAggregate coverageReport
     - name: Publish coverage report

LICENSE

@@ -1,5 +1,5 @@
 /*
-Copyright (C) 2020 Electronic Arts Inc.  All rights reserved.
+Copyright (C) 2021 Electronic Arts Inc.  All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions

README.md

@@ -21,9 +21,9 @@ And since a HTTP/JSON API is exposed, you don't necessarily have to deal with th
 
 ## Usage
 
-- Add **kara** as a plugin to the sbt project adding a line containing `addSbtPlugin("com.ea.kara" % "kara" % "0.1.0")` in `project/plugins.sbt`.
+- Add **kara** as a plugin to the sbt project adding a line containing `addSbtPlugin("com.ea.kara" % "kara" % "0.2.0")` in `project/plugins.sbt`.
 - In your project settings in `build.sbt`:
-  - configure `karaServices = Seq("fully_qualified_service_1", "fully_qualified_service_2, ...)` to indicate the Thrift services Kara should generate Finagle services and Swagger UI for. Services should be listed in `<JAVA_NAMESPACE>.<SERVICE_NAME>` format.
+  - configure `karaServices := Seq("fully_qualified_service_1", "fully_qualified_service_2, ...)` to indicate the Thrift services Kara should generate Finagle services and Swagger UI for. Services should be listed in `<JAVA_NAMESPACE>.<SERVICE_NAME>` format.
   - enable the the plugin with `.enablePlugins(Kara)` on the project that lists the Thrift sources and on which `ScroogeSBT` is enabled.
 
 On compilation (`sbt compile`), a Finagle HTTP service named `Http<SERVICE_NAME>` is generated, which takes as input an instance of a [Scrooge](http://twitter.github.io/scrooge/)-generated Thrift service `<SERVICE_NAME>.MethodPerEndpoint`. All is left to do is to instantiate it in your app and bind it to a Finagle server on a port of your choice.
@@ -33,7 +33,7 @@ On compilation (`sbt compile`), a Finagle HTTP service named `Http<SERVICE_NAME>
 #### project/plugins.sbt
 
 ```scala
-addSbtPlugin("com.ea.kara" % "kara" % "0.1.0")
+addSbtPlugin("com.ea.kara" % "kara" % "0.2.0")
 ```
 
 #### build.sbt
@@ -66,9 +66,12 @@ Http.server.serve(":8080", karaSvc)
 
 [Scripted tests](./src/sbt-test/kara/) are a great way to see **kara** in action.
 
-## Swagger UI
+## Dependency Map
 
-`kara` v.`0.1.0` employs Swagger UI v.`3.31.1`.
+| **kara** | **Swagger UI** | **Finagle / Scrooge** |
+|:--------:|:--------------:|:---------------------:|
+|  0.2.0   |     3.38.0     |        20.10.0        |
+|  0.1.0   |     3.31.1     |        20.5.0         |
 
 ## Testing
 

build.sbt

@@ -1,10 +1,10 @@
 /*
- * Copyright (C) 2020 Electronic Arts Inc.  All rights reserved.
+ * Copyright (C) 2021 Electronic Arts Inc.  All rights reserved.
  */
 
 import sbt._
 
-val finagleVersion = "20.5.0"
+val finagleVersion = "20.10.0"
 
 credentials += Credentials(Path.userHome / ".ivy2" / ".credentials")
 
@@ -39,10 +39,10 @@ lazy val root = (project in file("."))
     publishSettings,
     addSbtPlugin("com.twitter" % "scrooge-sbt-plugin" % finagleVersion),
     libraryDependencies ++= Seq(
-      "commons-io"            % "commons-io"     % "2.7",
+      "commons-io"            % "commons-io"     % "2.8.0",
       "org.scalatra.scalate" %% "scalate-core"   % "1.9.6",
       "com.twitter"          %% "finagle-http"   % finagleVersion % Test,
-      "io.circe"             %% "circe-yaml"     % "0.13.0",
+      "io.circe"             %% "circe-yaml"     % "0.13.1",
       "com.github.pathikrit" %% "better-files"   % "3.9.1",
       "io.swagger.parser.v3"  % "swagger-parser" % "2.0.21"       % Test,
       "org.scalatest"        %% "scalatest"      % "3.2.1"        % Test

docs/README.md

@@ -22,7 +22,7 @@ And since a HTTP/JSON API is exposed, you don't necessarily have to deal with th
 ## Usage
 - Add **kara** as a plugin to the sbt project adding a line containing `addSbtPlugin("com.ea.kara" % "kara" % "@VERSION@")` in `project/plugins.sbt`.
 - In your project settings in `build.sbt`:
-    - configure `karaServices = Seq("fully_qualified_service_1", "fully_qualified_service_2, ...)` to indicate the Thrift services Kara should generate Finagle services and Swagger UI for. Services should be listed in `<JAVA_NAMESPACE>.<SERVICE_NAME>` format.
+    - configure `karaServices := Seq("fully_qualified_service_1", "fully_qualified_service_2, ...)` to indicate the Thrift services Kara should generate Finagle services and Swagger UI for. Services should be listed in `<JAVA_NAMESPACE>.<SERVICE_NAME>` format.
     - enable the the plugin with `.enablePlugins(Kara)` on the project that lists the Thrift sources and on which `ScroogeSBT` is enabled.
 
 On compilation (`sbt compile`), a Finagle HTTP service named `Http<SERVICE_NAME>` is generated, which takes as input an instance of a [Scrooge](http://twitter.github.io/scrooge/)-generated Thrift service `<SERVICE_NAME>.MethodPerEndpoint`. All is left to do is to instantiate it in your app and bind it to a Finagle server on a port of your choice.
@@ -62,8 +62,12 @@ Http.server.serve(":8080", karaSvc)
 
 [Scripted tests](./src/sbt-test/kara/) are a great way to see **kara** in action.
 
-## Swagger UI
-`kara` v.`@VERSION@` employs Swagger UI v.`3.31.1`.
+## Dependency Map
+
+| **kara** | **Swagger UI** | **Finagle / Scrooge** |
+|:--------:|:--------------:|:---------------------:|
+| 0.2.0    | 3.38.0         | 20.10.0               |
+| 0.1.0    | 3.31.1         | 20.5.0                |
 
 ## Testing
 **kara** features two modes of testing:

project/build.properties

@@ -1 +1 @@
-sbt.version=1.3.12
+sbt.version=1.4.6

project/metals.sbt

@@ -1,4 +1,4 @@
 // DO NOT EDIT! This file is auto-generated.
 // This file enables sbt-bloop to create bloop config files.
 
-addSbtPlugin("ch.epfl.scala" % "sbt-bloop" % "1.4.4-13-408f4d80")
+addSbtPlugin("ch.epfl.scala" % "sbt-bloop" % "1.4.6-15-209c2a5c")

project/plugins.sbt

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2020 Electronic Arts Inc.  All rights reserved.
+ * Copyright (C) 2021 Electronic Arts Inc.  All rights reserved.
  */
 
 libraryDependencies += "org.scala-sbt" %% "scripted-plugin" % sbtVersion.value

src/main/resources/swagger/oauth2-redirect.html

@@ -1,7 +1,9 @@
 <!doctype html>
 <html lang="en-US">
-<title>Swagger UI: OAuth2 Redirect</title>
-<body onload="run()">
+<head>
+    <title>Swagger UI: OAuth2 Redirect</title>
+</head>
+<body>
 </body>
 </html>
 <script>
@@ -65,4 +67,8 @@
         }
         window.close();
     }
+
+    window.addEventListener('DOMContentLoaded', function () {
+      run();
+    });
 </script>

src/main/resources/templates/package.mustache

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2020 Electronic Arts Inc.  All rights reserved.
+ * Copyright (C) 2021 Electronic Arts Inc.  All rights reserved.
  */
 
 // This file is autogenerated by kara. Do not edit.

src/main/resources/templates/service.mustache

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2020 Electronic Arts Inc.  All rights reserved.
+ * Copyright (C) 2021 Electronic Arts Inc.  All rights reserved.
  */
 
 // This file is autogenerated by kara. Do not edit.

src/main/scala/com/ea/kara/Constants.scala

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2020 Electronic Arts Inc.  All rights reserved.
+ * Copyright (C) 2021 Electronic Arts Inc.  All rights reserved.
  */
 
 package com.ea.kara

src/main/scala/com/ea/kara/Context.scala

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2020 Electronic Arts Inc.  All rights reserved.
+ * Copyright (C) 2021 Electronic Arts Inc.  All rights reserved.
  */
 
 package com.ea.kara
@@ -49,29 +49,39 @@ case class CodegenContext(
     val servicePackageAndName: Map[String, Seq[String]] = serviceNames
       .map { serviceName =>
         serviceName.lastIndexOf(".") match {
-          case -1    => ("", serviceName)
-          case index => serviceName.splitAt(index)
+          case -1 =>
+            throw new RuntimeException("Provided service names should be qualified by packages.")
+          case index =>
+            serviceName.splitAt(index)
         }
       }
       .groupBy(_._1)
       .map {
         case (k, v) => (k, v.map(_._2.tail))
       }
 
-    val servicesByDocument = thriftFiles
-      .flatMap(file =>
-        file.document.services.map(service => (file.document, service)).filter {
-          case (document, service) =>
-            servicePackageAndName
-              .get(document.javaNamespace)
-              .exists { serviceNames =>
-                serviceNames.contains(service.sid.name)
-              }
-        }
-      )
+    val docToSvc = thriftFiles
+      .flatMap(file => file.document.services.map(service => (file.document, service)))
+
+    val pkgToSvc = servicePackageAndName.flatMap {
+      case (pkg, names) => names.map((pkg, _))
+    }
+    val servicesByDocument: Map[Document, Seq[String]] = pkgToSvc
+      .map {
+        case (pkg, name) =>
+          docToSvc
+            .find {
+              case (doc, docSvc) =>
+                doc.javaNamespace == pkg &&
+                  docSvc.sid.name == name
+            }
+            .getOrElse {
+              throw new RuntimeException(s"No service '$name' found in package '$pkg'.")
+            }
+      }
       .groupBy(_._1)
       .map {
-        case (k, v) => (k, v.map(_._2.sid.name))
+        case (k, v) => (k, v.map(_._2.sid.name).toSeq)
       }
 
     servicesByDocument

src/main/scala/com/ea/kara/Generator.scala

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2020 Electronic Arts Inc.  All rights reserved.
+ * Copyright (C) 2021 Electronic Arts Inc.  All rights reserved.
  */
 
 package com.ea.kara

src/main/scala/com/ea/kara/Kara.scala

@@ -88,11 +88,15 @@ object Kara extends AutoPlugin {
         }
         generator.generateSources()
         val sources = listSources()
-        logger.success(s"Generated Kara sources: ${sources.map(_.name).mkString(", ")}")
+        logger.success(
+          s"Generated Kara sources: " +
+          sources.map(_.getPath()).mkString(", ")
+        )
         sources
       } else {
         logger.info(
-          s"Kara sources won't be generated, already existing and up to date: ${oldSources.map(_.name)}"
+          s"Kara sources won't be generated, already existing and up to date: " +
+          oldSources.map(_.getPath()).mkString(", ")
         )
         oldSources
       }
@@ -118,11 +122,15 @@ object Kara extends AutoPlugin {
         }
         generator.generateResources()
         val resources = listResources()
-        logger.success(s"Generated Kara resources: ${resources.map(_.name).mkString(", ")}")
+        logger.success(
+          s"Generated Kara resources: " +
+          resources.map(_.getPath()).mkString(", ")
+        )
         resources
       } else {
         logger.info(
-          s"Kara resources won't be generated, already existing and up to date: ${oldResources.map(_.name)}"
+          s"Kara resources won't be generated, already existing and up to date: " +
+          oldResources.map(_.getPath()).mkString(", ")
         )
         oldResources
       }

src/main/scala/com/ea/kara/bindings/DataTypeBindingsExtractor.scala

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2020 Electronic Arts Inc.  All rights reserved.
+ * Copyright (C) 2021 Electronic Arts Inc.  All rights reserved.
  */
 
 package com.ea.kara.bindings

src/main/scala/com/ea/kara/bindings/ServiceBindingsExtractor.scala

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2020 Electronic Arts Inc.  All rights reserved.
+ * Copyright (C) 2021 Electronic Arts Inc.  All rights reserved.
  */
 
 package com.ea.kara.bindings

src/main/scala/com/ea/kara/extensions/package.scala

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2020 Electronic Arts Inc.  All rights reserved.
+ * Copyright (C) 2021 Electronic Arts Inc.  All rights reserved.
  */
 
 package com.ea.kara

src/main/scala/com/ea/kara/oas/OAS.scala

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2020 Electronic Arts Inc.  All rights reserved.
+ * Copyright (C) 2021 Electronic Arts Inc.  All rights reserved.
  */
 
 package com.ea.kara.oas
@@ -12,6 +12,5 @@ object OAS {
 }
 
 case class OAS(json: Json) {
-  def asJsonString(): String = json.toString
   def asYamlString(): String = json.asYaml.spaces2.toString
 }

src/main/scala/com/ea/kara/oas/OASBuilder.scala

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2020 Electronic Arts Inc.  All rights reserved.
+ * Copyright (C) 2021 Electronic Arts Inc.  All rights reserved.
  */
 
 package com.ea.kara.oas

src/main/scala/com/ea/kara/parse/ThriftParser.scala

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2020 Electronic Arts Inc.  All rights reserved.
+ * Copyright (C) 2021 Electronic Arts Inc.  All rights reserved.
  */
 
 package com.ea.kara.parse

src/main/scala/com/ea/kara/write/ResourceWriter.scala

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2020 Electronic Arts Inc.  All rights reserved.
+ * Copyright (C) 2021 Electronic Arts Inc.  All rights reserved.
  */
 
 package com.ea.kara.write

src/main/scala/com/ea/kara/write/SourceWriter.scala

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2020 Electronic Arts Inc.  All rights reserved.
+ * Copyright (C) 2021 Electronic Arts Inc.  All rights reserved.
  */
 
 package com.ea.kara.write

src/sbt-test/kara/declaration_order/build.sbt

@@ -1,23 +1,23 @@
 /*
- * Copyright (C) 2020 Electronic Arts Inc.  All rights reserved.
+ * Copyright (C) 2021 Electronic Arts Inc.  All rights reserved.
  */
 
 import sbt._
 
-val twitterVersion = "19.8.0"
-val circeVersion   = "0.11.1"
+val twitterVersion = "20.10.0"
+val circeVersion   = "0.13.0"
 
 lazy val root = (project in file("."))
   .settings(
-    scalaVersion := "2.12.8",
+    scalaVersion := "2.12.12",
     libraryDependencies ++= Seq(
-      "com.twitter" %% "twitter-server"  % twitterVersion,
-      "com.twitter" %% "scrooge-core"    % twitterVersion,
-      "io.circe"    %% "circe-generic"   % circeVersion,
-      "io.circe"    %% "circe-parser"    % circeVersion
+      "com.twitter" %% "twitter-server" % twitterVersion,
+      "com.twitter" %% "scrooge-core"   % twitterVersion,
+      "io.circe"    %% "circe-generic"  % circeVersion,
+      "io.circe"    %% "circe-parser"   % circeVersion
     ),
     karaServices := Seq(
-      "com.dirty.StubService"
+      "com.example.StubService"
     )
   )
   .enablePlugins(Kara)

src/sbt-test/kara/declaration_order/project/plugins.sbt

@@ -1,9 +1,9 @@
 /*
- * Copyright (C) 2020 Electronic Arts Inc.  All rights reserved.
+ * Copyright (C) 2021 Electronic Arts Inc.  All rights reserved.
  */
 
 sys.props.get("plugin.version") match {
   case Some(x) => addSbtPlugin("com.ea.kara" % "kara" % x)
-  case _ => sys.error("""|The system property 'plugin.version' is not defined.
+  case _       => sys.error("""|The system property 'plugin.version' is not defined.
                          |Specify this property using the scriptedLaunchOpts -D.""".stripMargin)
 }

src/sbt-test/kara/declaration_order/src/main/thrift/declaration_order.thrift

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2020 Electronic Arts Inc.  All rights reserved.
+ * Copyright (C) 2021 Electronic Arts Inc.  All rights reserved.
  */
 
 namespace java com.example

src/sbt-test/kara/declaration_order/test

@@ -1,4 +1,4 @@
-# Copyright (C) 2020 Electronic Arts Inc.  All rights reserved.
+# Copyright (C) 2021 Electronic Arts Inc.  All rights reserved.
 
 # Make sure the generated sources compile
 > compile