New project structure and tests

Author: Walter

Dockerfile

@@ -0,0 +1,12 @@
+FROM openjdk:14-alpine AS build
+COPY . /sentency-server
+WORKDIR /sentency-server
+RUN ./gradlew assemble
+
+FROM openjdk:14-alpine
+EXPOSE 7000
+RUN mkdir /app
+COPY --from=build /sentency-server/build/libs/*.jar /app/sentency-server.jar
+RUN mkdir /resources
+COPY --from=build /sentency-server/resources/*.env /resources/
+ENTRYPOINT ["java","-jar","/app/sentency-server.jar"]

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Walter
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,45 @@
+# Sentency Server
+
+The server will be done using Javalin, a simple web framework for Java and Kotlin.
+
+## Third-Party Libraries
+
+Javalin come with built-in libraries but it's mostly a "plug what you need" type of framework, because of that we had to 
+add some third party libraries to fill some gaps:
+
+* [Ktor](https://ktor.io/): Ktor is an asynchronous framework for creating microservices, web applications, and more.
+* [Exposed](https://github.com/JetBrains/Exposed): an ORM framework for Kotlin created by JetBrains
+
+## Docker
+
+The project is configured to be deployed using docker. To build the docker image go to the root of the project and run
+the command:
+
+```bash
+ docker build -t sentency-server .
+```
+
+After the image is build to run locally you can execute:
+
+```bash
+docker run -p 5000:7000 sentency-server:latest 
+```
+
+Open the address **http://localhost:5000/docs** on your browser and you will see this project Swagger with
+APIs.
+
+## Environment variables
+
+The project use .env libraries to load environment variables. To change any parameter change the value inside 
+the file **development.env** that's inside the resource folder.
+
+If it's necessary to create a new .env file (production file for example), the file should comply with the following
+pattern:
+
+```bash
+ENVIRONMENT = development
+PREFIX = server
+```
+
+Inside the **Application.kt** the *loadEnvVariables()* function need to be update to match the new file 
+name and folder parameters

build.gradle.kts

@@ -0,0 +1,32 @@
+val ktor_version: String by project
+val kotlin_version: String by project
+val logback_version: String by project
+
+plugins {
+    application
+    kotlin("jvm") version "1.5.0"
+    kotlin("plugin.serialization") version "1.5.0"
+}
+
+group = "org.wcode"
+version = "0.0.1"
+application {
+    mainClass.set("org.wcode.ApplicationKt")
+}
+
+repositories {
+    mavenCentral()
+}
+
+dependencies {
+    implementation("io.ktor:ktor-server-core:$ktor_version")
+    implementation("io.ktor:ktor-auth:$ktor_version")
+    implementation("io.ktor:ktor-serialization:$ktor_version")
+    implementation("io.ktor:ktor-locations:$ktor_version")
+    implementation("io.ktor:ktor-client-core:$ktor_version")
+    implementation("io.ktor:ktor-client-core-jvm:$ktor_version")
+    implementation("io.ktor:ktor-client-apache:$ktor_version")
+    implementation("io.ktor:ktor-server-jetty:$ktor_version")
+    implementation("ch.qos.logback:logback-classic:$logback_version")
+    testImplementation("io.ktor:ktor-server-tests:$ktor_version")
+}

gradle.properties

@@ -0,0 +1,4 @@
+ktor_version=1.5.4
+kotlin_version=1.5.0
+logback_version=1.2.3
+kotlin.code.style=official

gradle/wrapper/gradle-wrapper.jar

@@ -1,5 +1,5 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-6.7-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-6.8-bin.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

gradle/wrapper/gradle-wrapper.properties

@@ -130,7 +130,7 @@ fi
 if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then
     APP_HOME=`cygpath --path --mixed "$APP_HOME"`
     CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
-    
+
     JAVACMD=`cygpath --unix "$JAVACMD"`
 
     # We build the pattern for arguments to be converted via cygpath

gradlew

@@ -40,7 +40,7 @@ if defined JAVA_HOME goto findJavaFromJavaHome
 
 set JAVA_EXE=java.exe
 %JAVA_EXE% -version >NUL 2>&1
-if "%ERRORLEVEL%" == "0" goto init
+if "%ERRORLEVEL%" == "0" goto execute
 
 echo.
 echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
@@ -54,7 +54,7 @@ goto fail
 set JAVA_HOME=%JAVA_HOME:"=%
 set JAVA_EXE=%JAVA_HOME%/bin/java.exe
 
-if exist "%JAVA_EXE%" goto init
+if exist "%JAVA_EXE%" goto execute
 
 echo.
 echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
@@ -64,29 +64,14 @@ echo location of your Java installation.
 
 goto fail
 
-:init
-@rem Get command-line arguments, handling Windows variants
-
-if not "%OS%" == "Windows_NT" goto win9xME_args
-
-:win9xME_args
-@rem Slurp the command line arguments.
-set CMD_LINE_ARGS=
-set _SKIP=2
-
-:win9xME_args_slurp
-if "x%~1" == "x" goto execute
-
-set CMD_LINE_ARGS=%*
-
 :execute
 @rem Setup the command line
 
 set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
 
 
 @rem Execute Gradle
-"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS%
+"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %*
 
 :end
 @rem End local scope for the variables with windows NT shell

gradlew.bat

@@ -0,0 +1,5 @@
+ENVIRONMENT = development
+DB_USER = user
+DB_NAME = sentency_db
+DB_PASSWORD = eYPpJe8XBdqMaZ8j4C7QnqVcSSVctQ
+JWT_SECRET_KEY = SOMESECURESECRETKEY

resources/development.env

@@ -0,0 +1,5 @@
+ENVIRONMENT = production
+DB_USER = user
+DB_NAME = sentency_db
+DB_PASSWORD = eYPpJe8XBdqMaZ8j4C7QnqVcSSVctQ
+JWT_SECRET_KEY = SOMESECURESECRETKEY

resources/production.env

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module external.linked.project.id="sentency-server" external.linked.project.path="$MODULE_DIR$" external.root.project.path="$MODULE_DIR$" external.system.id="GRADLE" type="JAVA_MODULE" version="4">
+  <component name="NewModuleRootManager" inherit-compiler-output="true">
+    <exclude-output />
+    <content url="file://$MODULE_DIR$" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+</module>

sentency-server.iml

@@ -0,0 +1 @@
+rootProject.name = "sentency-server"

settings.gradle.kts

@@ -0,0 +1,18 @@
+package org.wcode
+
+import io.ktor.application.*
+import io.ktor.server.engine.*
+import io.ktor.server.jetty.*
+import org.wcode.plugins.*
+
+fun main() {
+    embeddedServer(Jetty, port = 8080, host = "0.0.0.0") {
+        setupApplication()
+    }.start(wait = true)
+}
+
+fun Application.setupApplication(){
+    configureModules()
+    configureRouting()
+    configureHTTP()
+}

src/main/kotlin/org/wcode/Application.kt

@@ -0,0 +1,16 @@
+package org.wcode.models
+
+import kotlinx.serialization.Serializable
+import kotlinx.serialization.encodeToString
+import kotlinx.serialization.json.Json
+import java.util.*
+
+@Serializable
+data class Quote(val id: String = UUID.randomUUID().toString(), val message: String, val authorId: String) {
+
+    fun toJson(): String {
+        return Json.encodeToString(this)
+    }
+}
+
+val quoteStorage = mutableListOf<Quote>()

src/main/kotlin/org/wcode/models/Quote.kt

@@ -0,0 +1,20 @@
+package org.wcode.plugins
+
+import io.ktor.http.*
+import io.ktor.application.*
+import io.ktor.features.*
+import io.ktor.response.*
+import io.ktor.request.*
+
+fun Application.configureHTTP() {
+    install(CORS) {
+        method(HttpMethod.Options)
+        method(HttpMethod.Put)
+        method(HttpMethod.Delete)
+        method(HttpMethod.Patch)
+        header(HttpHeaders.Authorization)
+        header("MyCustomHeader")
+        allowCredentials = true
+        anyHost() // @TODO: Don't do this in production if possible. Try to limit it.
+    }
+}

src/main/kotlin/org/wcode/plugins/HTTP.kt

@@ -0,0 +1,11 @@
+package org.wcode.plugins
+
+import io.ktor.application.*
+import io.ktor.features.*
+import io.ktor.serialization.*
+
+fun Application.configureModules() {
+    install(ContentNegotiation) {
+        json()
+    }
+}

src/main/kotlin/org/wcode/plugins/Modules.kt

@@ -0,0 +1,15 @@
+package org.wcode.plugins
+
+import io.ktor.routing.*
+import io.ktor.application.*
+import io.ktor.response.*
+import org.wcode.routes.quoteRouting
+
+fun Application.configureRouting() {
+    routing {
+        get("/") {
+            call.respondText("Hello World!")
+        }
+        quoteRouting()
+    }
+}

src/main/kotlin/org/wcode/plugins/Routing.kt

@@ -0,0 +1,47 @@
+package org.wcode.routes
+
+import io.ktor.application.*
+import io.ktor.http.*
+import io.ktor.request.*
+import io.ktor.response.*
+import io.ktor.routing.*
+import org.wcode.models.Quote
+import org.wcode.models.quoteStorage
+import java.util.*
+
+fun Route.quoteRouting(){
+    route("/quotes") {
+        get {
+            if (quoteStorage.isNotEmpty()) {
+                call.respond(quoteStorage)
+            } else {
+                call.respondText("No quotes found", status = HttpStatusCode.NotFound)
+            }
+        }
+        get("{id}") {
+            val id = call.parameters["id"] ?: return@get call.respondText(
+                "Missing or malformed id",
+                status = HttpStatusCode.BadRequest
+            )
+            val quote =
+                quoteStorage.find { it.id == id } ?: return@get call.respondText(
+                    "No quote with id $id",
+                    status = HttpStatusCode.NotFound
+                )
+            call.respond(quote)
+        }
+        post {
+            val quote = call.receive<Quote>()
+            quoteStorage.add(quote)
+            call.respondText("Quote stored correctly", status = HttpStatusCode.Created)
+        }
+        delete("{id}") {
+            val id = call.parameters["id"] ?: return@delete call.respond(HttpStatusCode.BadRequest)
+            if (quoteStorage.removeIf { it.id == id }) {
+                call.respondText("Quote removed correctly", status = HttpStatusCode.Accepted)
+            } else {
+                call.respondText("Not Found", status = HttpStatusCode.NotFound)
+            }
+        }
+    }
+}

src/main/kotlin/org/wcode/routes/QuoteRoutes.kt

@@ -0,0 +1,12 @@
+<configuration>
+    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
+        <encoder>
+            <pattern>%d{YYYY-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
+        </encoder>
+    </appender>
+    <root level="trace">
+        <appender-ref ref="STDOUT"/>
+    </root>
+    <logger name="org.eclipse.jetty" level="INFO"/>
+    <logger name="io.netty" level="INFO"/>
+</configuration>

src/main/resources/logback.xml

@@ -0,0 +1,18 @@
+package org.wcode
+
+import io.ktor.http.*
+import kotlin.test.*
+import io.ktor.server.testing.*
+import org.wcode.plugins.configureRouting
+
+class ApplicationTest {
+    @Test
+    fun testRoot() {
+        withTestApplication({ configureRouting() }) {
+            handleRequest(HttpMethod.Get, "/").apply {
+                assertEquals(HttpStatusCode.OK, response.status())
+                assertEquals("Hello World!", response.content)
+            }
+        }
+    }
+}

src/test/kotlin/org/wcode/ApplicationTest.kt

@@ -0,0 +1,39 @@
+package org.wcode.routes
+
+import io.ktor.http.*
+import io.ktor.server.testing.*
+import org.junit.Test
+import org.wcode.models.Quote
+import org.wcode.setupApplication
+import kotlin.test.assertEquals
+
+class QuoteRoutesTest {
+
+    @Test
+    fun `Add Customer with ID`() {
+        val quote = Quote(id = "Teste", message = "Test", authorId = "Test")
+        withTestApplication({ setupApplication() }) {
+            handleRequest(HttpMethod.Post, "/quotes") {
+                addHeader(HttpHeaders.ContentType, ContentType.Application.Json.toString())
+                setBody(quote.toJson())
+            }.apply {
+                assertEquals(HttpStatusCode.Created, response.status())
+                assertEquals("Quote stored correctly", response.content)
+            }
+        }
+    }
+
+    @Test
+    fun `Add Customer without ID`() {
+        val quote = Quote( message = "Test", authorId = "Test")
+        withTestApplication({ setupApplication() }) {
+            handleRequest(HttpMethod.Post, "/quotes") {
+                addHeader(HttpHeaders.ContentType, ContentType.Application.Json.toString())
+                setBody(quote.toJson())
+            }.apply {
+                assertEquals(HttpStatusCode.Created, response.status())
+                assertEquals("Quote stored correctly", response.content)
+            }
+        }
+    }
+}