basic register flow

.github/workflows/hndrs-gradle-check.yml

@@ -12,6 +12,11 @@ jobs:
   check:
     runs-on: ubuntu-latest
 
+    services:
+      mongodb:
+        image: mongo
+        ports:
+          - 27017:27017
     steps:
       - name: git checkout
         uses: actions/checkout@v2
@@ -33,5 +38,10 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-gradle-
       - name: test
+        env:
+          ARTIFACTS_AUTH0_DOMAIN: ${{ secrets.ARTIFACTS_AUTH0_DOMAIN }}
+          ARTIFACTS_AUTH0_CLIENTID: ${{ secrets.ARTIFACTS_AUTH0_CLIENTID }}
+          ARTIFACTS_AUTH0_CLIENTSECRET: ${{ secrets.ARTIFACTS_AUTH0_CLIENTSECRET }}
+          HNDRS_JWT_KEYSTOREPATH: ${{ secrets.ARTIFACTS_AUTH0_KEYSTOREPATH }}
         run: |
-          ./gradlew check
+          ./gradlew check -Dspring.profiles.active=ci

.github/workflows/hndrs-gradle-sonar.yml

@@ -16,6 +16,12 @@ jobs:
   analyse:
     runs-on: ubuntu-latest
 
+    services:
+      mongodb:
+        image: mongo
+        ports:
+          - 27017:27017
+
     steps:
       - name: git checkout
         uses: actions/checkout@v2
@@ -46,5 +52,9 @@ jobs:
       - name: analyse
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}  # Needed to get PR information, if any
+          ARTIFACTS_AUTH0_DOMAIN: ${{ secrets.ARTIFACTS_AUTH0_DOMAIN }}
+          ARTIFACTS_AUTH0_CLIENTID: ${{ secrets.ARTIFACTS_AUTH0_CLIENTID }}
+          ARTIFACTS_AUTH0_CLIENTSECRET: ${{ secrets.ARTIFACTS_AUTH0_CLIENTSECRET }}
+          HNDRS_JWT_KEYSTOREPATH: ${{ secrets.ARTIFACTS_AUTH0_KEYSTOREPATH }}
           SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
-        run: ./gradlew check jacocoTestReport sonarqube --info
+        run: ./gradlew check jacocoTestReport sonarqube --info -Dspring.profiles.active=ci

.gitignore

@@ -35,3 +35,7 @@ out/
 
 ### VS Code ###
 .vscode/
+
+### Spring Boot ###
+/config/*
+!/config/*.example

application-ci.properties

@@ -0,0 +1 @@
+spring.data.mongodb.uri=mongodb://mongodb/local_artifacts?retryWrites=true&w=majority

application.properties

@@ -0,0 +1,4 @@
+logging.level.org.springframework.boot.autoconfigure=DEBUG
+#Mongo DB
+spring.data.mongodb.auto-index-creation=true
+spring.data.mongodb.uri=mongodb://localhost/local_artifacts?retryWrites=true&w=majority

build.gradle.kts

@@ -1,11 +1,12 @@
 import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
 
 plugins {
-    id("org.springframework.boot") version "2.4.3"
-    id("io.spring.dependency-management") version "1.0.11.RELEASE"
-    id("org.sonarqube").version("3.1.1")
-    kotlin("jvm") version "1.4.30"
-    kotlin("plugin.spring") version "1.4.30"
+    id("org.springframework.boot")
+    id("io.spring.dependency-management")
+    id("org.sonarqube").version("3.3")
+    kotlin("jvm")
+    kotlin("plugin.spring")
+    kotlin("kapt")
     jacoco
 }
 
@@ -17,17 +18,32 @@ repositories {
     mavenCentral()
 }
 
+dependencyManagement {
+    imports {
+        mavenBom("com.squareup.okhttp3:okhttp-bom:4.9.0")
+    }
+}
+
+
 dependencies {
     implementation("org.springframework.boot:spring-boot-starter-web")
     implementation("com.fasterxml.jackson.module:jackson-module-kotlin")
+    implementation("org.springframework.boot:spring-boot-starter-data-mongodb")
     implementation("org.jetbrains.kotlin:kotlin-reflect")
 
+    implementation("com.auth0:auth0:1.33.0")
+    implementation("io.springfox:springfox-boot-starter:3.0.0")
     //hndrs
     implementation("io.hndrs:jsonapi-spring-boot-starter:1.0.0")
+    implementation("io.hndrs:jwt-auth-spring-boot-starter:1.0.0")
 
+    kapt(group = "org.springframework.boot", name = "spring-boot-configuration-processor")
 
     implementation("org.jetbrains.kotlin:kotlin-stdlib-jdk8")
-    testImplementation("org.springframework.boot:spring-boot-starter-test")
+    testImplementation("org.springframework.boot:spring-boot-starter-test") {
+        exclude(module = "mockito-core")
+    }
+    testImplementation("com.ninja-squad:springmockk:3.0.1")
 }
 
 sonarqube {
@@ -39,7 +55,7 @@ sonarqube {
 }
 
 jacoco {
-    toolVersion = "0.8.6"
+    toolVersion = "0.8.7"
 }
 
 tasks.withType<JacocoReport> {
@@ -59,4 +75,7 @@ tasks.withType<KotlinCompile> {
 
 tasks.withType<Test> {
     useJUnitPlatform()
+    System.getProperty("spring.profiles.active")?.let {
+        systemProperties.put("spring.profiles.active", it)
+    }
 }

config/application.properties.example

@@ -0,0 +1,4 @@
+hndrs.jwt.key-store-path=
+artifacts.auth0.domain=
+artifacts.auth0.client-id=
+artifacts.auth0.client-secret=

gradle.properties

@@ -0,0 +1,3 @@
+kotlinVersion=1.5.20
+springDependencyManagement=1.0.11.RELEASE
+springBootDependencies=2.5.3

settings.gradle.kts

@@ -1 +1,18 @@
 rootProject.name = "artifacts"
+
+pluginManagement {
+    val kotlinVersion: String by settings
+    val springDependencyManagement: String by settings
+    val springBootDependencies: String by settings
+
+    plugins {
+        id("org.springframework.boot").version(springBootDependencies)
+        id("io.spring.dependency-management").version(springDependencyManagement)
+        kotlin("jvm").version(kotlinVersion)
+        kotlin("plugin.spring").version(kotlinVersion)
+        kotlin("kapt").version(kotlinVersion)
+        id("idea")
+    }
+    repositories {
+    }
+}

src/main/kotlin/io/hndrs/artifacts/OpenApiConfiguration.kt

@@ -0,0 +1,39 @@
+package io.hndrs.artifacts
+
+import org.springframework.context.annotation.Bean
+import org.springframework.context.annotation.Configuration
+import org.springframework.core.annotation.Order
+import org.springframework.stereotype.Component
+import springfox.documentation.builders.RequestHandlerSelectors
+import springfox.documentation.service.Tag
+import springfox.documentation.spi.DocumentationType
+import springfox.documentation.spi.DocumentationType.OAS_30
+import springfox.documentation.spi.service.OperationBuilderPlugin
+import springfox.documentation.spi.service.contexts.OperationContext
+import springfox.documentation.spring.web.plugins.Docket
+import springfox.documentation.swagger.common.SwaggerPluginSupport
+
+@Configuration
+class OpenApiConfiguration {
+
+
+    @Bean
+    fun docket(): Docket = Docket(OAS_30)
+        .tags(Tag("Artifacts Api", "analysis description"))
+        .select()
+        .apis(RequestHandlerSelectors.basePackage("io.hndrs"))
+        .build()
+}
+
+@Component
+@Order(SwaggerPluginSupport.SWAGGER_PLUGIN_ORDER + 1)
+class GlobalTag : OperationBuilderPlugin {
+    override fun supports(delimiter: DocumentationType): Boolean {
+        return delimiter == OAS_30
+    }
+
+    override fun apply(context: OperationContext) {
+        context.operationBuilder().tags(setOf("Artifacts Api"))
+    }
+
+}

src/main/kotlin/io/hndrs/artifacts/configuration/Auth0Configuration.kt

@@ -0,0 +1,38 @@
+package io.hndrs.artifacts.configuration
+
+import com.auth0.client.auth.AuthAPI
+import com.auth0.client.mgmt.ManagementAPI
+import org.springframework.boot.context.properties.ConfigurationProperties
+import org.springframework.boot.context.properties.EnableConfigurationProperties
+import org.springframework.context.annotation.Bean
+import org.springframework.context.annotation.Configuration
+
+@Configuration
+@EnableConfigurationProperties(Auth0ConfigurationProperties::class)
+class Auth0Configuration(private val properties: Auth0ConfigurationProperties) {
+
+    @Bean
+    fun managementApi(): ManagementAPI {
+        val authAPI = AuthAPI(
+            properties.domain,
+            properties.clientId,
+            properties.clientSecret
+        )
+
+        val accessToken = authAPI.requestToken("${properties.domain}/api/v2/").execute().accessToken
+
+        return ManagementAPI(properties.domain, accessToken)
+    }
+}
+
+@ConfigurationProperties(prefix = "artifacts.auth0")
+open class Auth0ConfigurationProperties {
+
+    lateinit var domain: String
+
+    lateinit var clientId: String
+
+    lateinit var clientSecret: String
+
+
+}

src/main/kotlin/io/hndrs/artifacts/configuration/OpenApiConfiguration.kt

@@ -0,0 +1,2 @@
+package io.hndrs.artifacts.configuration
+

src/main/kotlin/io/hndrs/artifacts/domain/UserController.kt → src/main/kotlin/io/hndrs/artifacts/module/artifacts/ArtifactsController.kt

@@ -1,18 +1,14 @@
-package io.hndrs.artifacts.domain
+package io.hndrs.artifacts.module.artifacts
 
 import io.hndrs.api.response.JsonApiResponse
-import io.hndrs.artifacts.shared.User
 import org.springframework.web.bind.annotation.GetMapping
 import org.springframework.web.bind.annotation.RestController
 
 @RestController
-class UserController {
+class ArtifactsController {
 
-
-    @GetMapping("/user")
+    @GetMapping("/artifacts")
     @JsonApiResponse
-    fun user(): User {
-        return User("id")
+    fun artifacts() {
     }
-
 }

src/main/kotlin/io/hndrs/artifacts/module/organisation/OrganisationArtifactsController.kt

@@ -0,0 +1,26 @@
+package io.hndrs.artifacts.module.organisation
+
+import io.hndrs.api.response.JsonApiResponse
+import io.swagger.annotations.ApiImplicitParam
+import org.springframework.web.bind.annotation.GetMapping
+import org.springframework.web.bind.annotation.PathVariable
+import org.springframework.web.bind.annotation.RestController
+
+@RestController
+class OrganisationArtifactsController {
+
+    @ApiImplicitParam(
+        name = "Authorization",
+        value = "Id Token",
+        required = true,
+        allowEmptyValue = false,
+        paramType = "header",
+        dataTypeClass = String::class,
+        example = "Bearer id_token"
+    )
+    @GetMapping("/organisations/{orgainsation_id}/artifacts")
+    @JsonApiResponse
+    fun organisationArtifacts(@PathVariable("orgainsation_id") organisationId: String) {
+    }
+
+}

src/main/kotlin/io/hndrs/artifacts/module/organisation/OrganisationsController.kt

@@ -0,0 +1,26 @@
+package io.hndrs.artifacts.module.organisation
+
+import io.hndrs.api.response.JsonApiResponse
+import io.hndrs.jwt.Identity
+import io.swagger.annotations.ApiImplicitParam
+import org.springframework.web.bind.annotation.GetMapping
+import org.springframework.web.bind.annotation.RestController
+
+@RestController
+class OrganisationsController {
+
+    @ApiImplicitParam(
+        name = "Authorization",
+        value = "Id Token",
+        required = true,
+        allowEmptyValue = false,
+        paramType = "header",
+        dataTypeClass = String::class,
+        example = "Bearer id_token"
+    )
+    @GetMapping("/organisations")
+    @JsonApiResponse
+    fun organisation(@Identity user: Map<String, Any>) {
+    }
+
+}

src/main/kotlin/io/hndrs/artifacts/module/project/ProjectsController.kt

@@ -0,0 +1,26 @@
+package io.hndrs.artifacts.module.project
+
+import io.hndrs.api.response.JsonApiResponse
+import io.hndrs.jwt.Identity
+import io.swagger.annotations.ApiImplicitParam
+import org.springframework.web.bind.annotation.GetMapping
+import org.springframework.web.bind.annotation.RestController
+
+@RestController
+class ProjectsController {
+
+    @ApiImplicitParam(
+        name = "Authorization",
+        value = "Id Token",
+        required = true,
+        allowEmptyValue = false,
+        paramType = "header",
+        dataTypeClass = String::class,
+        example = "Bearer id_token"
+    )
+    @GetMapping("/projects")
+    @JsonApiResponse
+    fun projects(@Identity user: Map<String, Any>) {
+    }
+
+}

src/main/kotlin/io/hndrs/artifacts/module/team/TeamsController.kt

@@ -0,0 +1,26 @@
+package io.hndrs.artifacts.module.team
+
+import io.hndrs.api.response.JsonApiResponse
+import io.hndrs.jwt.Identity
+import io.swagger.annotations.ApiImplicitParam
+import org.springframework.web.bind.annotation.GetMapping
+import org.springframework.web.bind.annotation.RestController
+
+@RestController
+class TeamsController {
+
+    @ApiImplicitParam(
+        name = "Authorization",
+        value = "Id Token",
+        required = true,
+        allowEmptyValue = false,
+        paramType = "header",
+        dataTypeClass = String::class,
+        example = "Bearer id_token"
+    )
+    @GetMapping("/teams")
+    @JsonApiResponse
+    fun teams(@Identity user: Map<String, Any>) {
+    }
+
+}