feature/유저회원가입-documentation

feature/유저회원가입-documentation

Author: BAEKJungHo

authentication-service/src/test/kotlin/com/expedia/authentication/acceptance/user/UserAcceptanceTest.kt

@@ -7,7 +7,7 @@ internal class UserAcceptanceTest: AcceptanceTest() {
 
     @Test
     fun `회원 가입을 한다`() {
-        val response = `회원 생성 요청`("[email protected]", "jungho")
+        val response = `회원 생성 요청`()
         `회원이 생성 됨`(response)
     }
 }

authentication-service/src/test/kotlin/com/expedia/authentication/acceptance/user/UserSteps.kt

@@ -1,5 +1,6 @@
 package com.expedia.authentication.acceptance.user
 
+import com.expedia.authentication.payload.createUserPayloads
 import io.restassured.RestAssured
 import io.restassured.response.ExtractableResponse
 import io.restassured.response.Response
@@ -8,15 +9,11 @@ import org.springframework.http.HttpStatus
 import org.springframework.http.MediaType
 
 
-internal fun `회원 생성 요청`(email: String, password: String): ExtractableResponse<Response> {
-    val params: MutableMap<String, String> = HashMap()
-    params["email"] = email
-    params["password"] = password
-
+internal fun `회원 생성 요청`(): ExtractableResponse<Response> {
     return RestAssured
         .given().log().all()
         .contentType(MediaType.APPLICATION_JSON_VALUE)
-        .body(params)
+        .body(createUserPayloads())
         .`when`().post("/users")
         .then().log().all().extract()
 }

authentication-service/src/test/kotlin/com/expedia/authentication/documentation/Documentation.kt

@@ -0,0 +1,33 @@
+package com.expedia.authentication.documentation
+
+import io.restassured.RestAssured
+import io.restassured.builder.RequestSpecBuilder
+import io.restassured.specification.RequestSpecification
+import org.junit.jupiter.api.extension.ExtendWith
+import org.springframework.boot.test.context.SpringBootTest
+import org.springframework.boot.web.server.LocalServerPort
+import org.springframework.restdocs.RestDocumentationContextProvider
+import org.springframework.restdocs.RestDocumentationExtension
+import org.springframework.restdocs.operation.preprocess.Preprocessors.prettyPrint
+import org.springframework.restdocs.restassured3.RestAssuredRestDocumentation.documentationConfiguration
+
+
+@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
+@ExtendWith(RestDocumentationExtension::class)
+internal class Documentation {
+
+    @LocalServerPort
+    lateinit var port: String
+
+    protected lateinit var spec: RequestSpecification
+
+    fun setUp(documentation: RestDocumentationContextProvider) {
+        RestAssured.port = port.toInt()
+        this.spec = RequestSpecBuilder()
+            .addFilter(documentationConfiguration(documentation)
+                    .operationPreprocessors()
+                    .withRequestDefaults(prettyPrint())
+                    .withResponseDefaults(prettyPrint()))
+            .build()
+    }
+}

authentication-service/src/test/kotlin/com/expedia/authentication/documentation/user/DocumentationFilter.kt

@@ -0,0 +1,26 @@
+package com.expedia.authentication.documentation.user
+
+import org.springframework.http.HttpHeaders
+import org.springframework.http.MediaType
+import org.springframework.restdocs.headers.HeaderDocumentation.headerWithName
+import org.springframework.restdocs.headers.HeaderDocumentation.requestHeaders
+import org.springframework.restdocs.payload.PayloadDocumentation.fieldWithPath
+import org.springframework.restdocs.payload.PayloadDocumentation.responseFields
+import org.springframework.restdocs.restassured3.RestAssuredRestDocumentation.document
+import org.springframework.restdocs.restassured3.RestDocumentationFilter
+
+class DocumentationFilter {
+    companion object {
+        fun `회원 생성`(): RestDocumentationFilter {
+            return document("createUser",
+                requestHeaders(
+                    headerWithName(HttpHeaders.CONTENT_TYPE).description(MediaType.APPLICATION_JSON_VALUE)
+                ),
+                responseFields(
+                    fieldWithPath("email").description("이메일"),
+                    fieldWithPath("password").description("패스워드"),
+                )
+            )
+        }
+    }
+}

authentication-service/src/test/kotlin/com/expedia/authentication/documentation/user/UserDocumentation.kt

@@ -0,0 +1,34 @@
+package com.expedia.authentication.documentation.user
+
+import com.expedia.authentication.documentation.Documentation
+import com.expedia.authentication.payload.createUserPayloads
+import io.restassured.RestAssured
+import io.restassured.response.ExtractableResponse
+import io.restassured.response.Response
+import io.restassured.specification.RequestSpecification
+import org.assertj.core.api.Assertions.assertThat
+import org.junit.jupiter.api.Test
+import org.springframework.http.HttpStatus
+import org.springframework.http.MediaType
+
+internal class UserDocumentation: Documentation() {
+
+    @Test
+    fun `회원 가입을 한다`() {
+        val response = `회원 생성 요청`(spec)
+        `회원이 생성 됨`(response)
+    }
+}
+
+internal fun `회원 생성 요청`(spec: RequestSpecification): ExtractableResponse<Response> {
+    return RestAssured
+        .given(spec).log().all()
+        .filter(DocumentationFilter.`회원 생성`())
+        .contentType(MediaType.APPLICATION_JSON_VALUE)
+        .body(createUserPayloads())
+        .`when`().post("/users")
+        .then().log().all().extract()
+}
+
+internal fun `회원이 생성 됨`(response: ExtractableResponse<Response>) =
+    assertThat(response.statusCode()).isEqualTo(HttpStatus.CREATED.value())

authentication-service/src/test/kotlin/com/expedia/authentication/payload/UserPayload.kt

@@ -0,0 +1,7 @@
+package com.expedia.authentication.payload
+
+fun createUserPayloads() {
+    val params: MutableMap<String, String> = HashMap()
+    params["email"] = "[email protected]"
+    params["password"] = "1234"
+}