diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 000000000..865470c34 --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1 @@ +* @Choi-JJunho @Invidam @songsunkook @daheeParkk diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.md b/.github/ISSUE_TEMPLATE/BUG_REPORT.md new file mode 100644 index 000000000..38a3e2965 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/BUG_REPORT.md @@ -0,0 +1,11 @@ +--- +name: Bug Report +about: 버그 리포트 +title: '' +labels: "bug" +assignees: '' +--- + +## 요약 + +## 특이사항 diff --git a/.github/ISSUE_TEMPLATE/DEFAULT.md b/.github/ISSUE_TEMPLATE/DEFAULT.md new file mode 100644 index 000000000..3cd23a492 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/DEFAULT.md @@ -0,0 +1,10 @@ +--- +name: Default Issue +about: 기본 양식 +title: '' +labels: '' +assignees: '' + +--- + +# 어떤 이슈인가요? diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..ac8c18b36 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,9 @@ +# 🔥 연관 이슈 + +- close #이슈번호 + +# 🚀 작업 내용 + +1. + +# 💬 리뷰 중점사항 diff --git a/.github/workflows/backend_ci.yml b/.github/workflows/backend_ci.yml new file mode 100644 index 000000000..17b3b2202 --- /dev/null +++ b/.github/workflows/backend_ci.yml @@ -0,0 +1,47 @@ +name: KOIN_API_V2 CI Config + +on: + push: + paths: '/**' + pull_request: + branches: + - develop + - main + +permissions: + pull-requests: write + checks: write + +jobs: + build: + + runs-on: ubuntu-latest + + steps: + - name: Set up Repository + uses: actions/checkout@v3 + + - name: Set up JDK 17 + uses: actions/setup-java@v3 + with: + java-version: '17' + distribution: 'temurin' + + - name: Give permission for Gradle + run: chmod +x gradlew + + - name: Run gradle build + run: ./gradlew build + + - name: comments test result on PR + uses: EnricoMi/publish-unit-test-result-action@v1 + if: always() + with: + files: '**/build/test-results/test/TEST-*.xml' + + - name: comments test result in failed line if test failed + uses: mikepenz/action-junit-report@v3 + if: always() + with: + report_paths: '**/build/test-results/test/TEST-*.xml' + token: ${{ github.token }} diff --git a/.gitignore b/.gitignore new file mode 100644 index 000000000..98412772b --- /dev/null +++ b/.gitignore @@ -0,0 +1,40 @@ +HELP.md +.gradle +build/ +!gradle/wrapper/gradle-wrapper.jar +!**/src/main/**/build/ +!**/src/test/**/build/ + +### STS ### +.apt_generated +.classpath +.factorypath +.project +.settings +.springBeans +.sts4-cache +bin/ +!**/src/main/**/bin/ +!**/src/test/**/bin/ + +### IntelliJ IDEA ### +.idea +*.iws +*.iml +*.ipr +out/ +!**/src/main/**/out/ +!**/src/test/**/out/ + +### NetBeans ### +/nbproject/private/ +/nbbuild/ +/dist/ +/nbdist/ +/.nb-gradle/ + +### VS Code ### +.vscode/ +.DS_STORE + +application.yml diff --git a/README.md b/README.md new file mode 100644 index 000000000..2c9a208ce --- /dev/null +++ b/README.md @@ -0,0 +1,3 @@ +# KOIN_API_V2 + +한국기술교육대학교 커뮤니티 서비스 API diff --git a/build.gradle b/build.gradle new file mode 100644 index 000000000..7f5da45c9 --- /dev/null +++ b/build.gradle @@ -0,0 +1,41 @@ +plugins { + id 'java' + id 'org.springframework.boot' version '3.1.5' + id 'io.spring.dependency-management' version '1.1.3' +} + +group = 'in.koreatech' + +java { + sourceCompatibility = '17' +} + +configurations { + compileOnly { + extendsFrom annotationProcessor + } +} + +repositories { + mavenCentral() +} + +dependencies { + implementation 'org.springframework.boot:spring-boot-starter-data-jpa' + implementation 'org.springframework.boot:spring-boot-starter-validation' + implementation 'org.springframework.boot:spring-boot-starter-web' + compileOnly 'org.projectlombok:lombok' + runtimeOnly 'com.h2database:h2' + runtimeOnly 'com.mysql:mysql-connector-j' + annotationProcessor 'org.projectlombok:lombok' + testImplementation 'io.rest-assured:rest-assured:5.3.2' + testImplementation 'org.springframework.boot:spring-boot-starter-test' +} + +tasks.named('bootBuildImage') { + builder = 'paketobuildpacks/builder-jammy-base:latest' +} + +tasks.named('test') { + useJUnitPlatform() +} diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 000000000..7f93135c4 Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 000000000..3fa8f862f --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,7 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-8.4-bin.zip +networkTimeout=10000 +validateDistributionUrl=true +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100755 index 000000000..1aa94a426 --- /dev/null +++ b/gradlew @@ -0,0 +1,249 @@ +#!/bin/sh + +# +# Copyright © 2015-2021 the original authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +# This is normally unused +# shellcheck disable=SC2034 +APP_BASE_NAME=${0##*/} +# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) +APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + if ! command -v java >/dev/null 2>&1 + then + die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Collect all arguments for the java command: +# * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, +# and any embedded shellness will be escaped. +# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be +# treated as '${Hostname}' itself on the command line. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Stop when "xargs" is not available. +if ! command -v xargs >/dev/null 2>&1 +then + die "xargs is not available" +fi + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 000000000..93e3f59f1 --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,92 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%"=="" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%"=="" set DIRNAME=. +@rem This is normally unused +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if %ERRORLEVEL% equ 0 goto execute + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +: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 %* + +:end +@rem End local scope for the variables with windows NT shell +if %ERRORLEVEL% equ 0 goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +set EXIT_CODE=%ERRORLEVEL% +if %EXIT_CODE% equ 0 set EXIT_CODE=1 +if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% +exit /b %EXIT_CODE% + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/settings.gradle b/settings.gradle new file mode 100644 index 000000000..f41416f2a --- /dev/null +++ b/settings.gradle @@ -0,0 +1 @@ +rootProject.name = 'KOIN_API_V2' diff --git a/src/main/java/in/koreatech/koin/KoinApplication.java b/src/main/java/in/koreatech/koin/KoinApplication.java new file mode 100644 index 000000000..fe91d572e --- /dev/null +++ b/src/main/java/in/koreatech/koin/KoinApplication.java @@ -0,0 +1,12 @@ +package in.koreatech.koin; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; + +@SpringBootApplication +public class KoinApplication { + + public static void main(String[] args) { + SpringApplication.run(KoinApplication.class, args); + } +} diff --git a/src/main/java/in/koreatech/koin/config/JpaConfiguration.java b/src/main/java/in/koreatech/koin/config/JpaConfiguration.java new file mode 100644 index 000000000..f1a948c05 --- /dev/null +++ b/src/main/java/in/koreatech/koin/config/JpaConfiguration.java @@ -0,0 +1,10 @@ +package in.koreatech.koin.config; + +import org.springframework.context.annotation.Configuration; +import org.springframework.data.jpa.repository.config.EnableJpaAuditing; + +@Configuration +@EnableJpaAuditing +public class JpaConfiguration { + +} diff --git a/src/main/java/in/koreatech/koin/controller/TrackController.java b/src/main/java/in/koreatech/koin/controller/TrackController.java new file mode 100644 index 000000000..236028202 --- /dev/null +++ b/src/main/java/in/koreatech/koin/controller/TrackController.java @@ -0,0 +1,30 @@ +package in.koreatech.koin.controller; + +import in.koreatech.koin.dto.TrackResponse; +import in.koreatech.koin.dto.TrackSingleResponse; +import in.koreatech.koin.service.TrackService; +import java.util.List; +import lombok.RequiredArgsConstructor; +import org.springframework.http.ResponseEntity; +import org.springframework.web.bind.annotation.GetMapping; +import org.springframework.web.bind.annotation.PathVariable; +import org.springframework.web.bind.annotation.RestController; + +@RestController +@RequiredArgsConstructor +public class TrackController { + + private final TrackService trackService; + + @GetMapping("/tracks") + public ResponseEntity> getTracks() { + List tracksResponse = trackService.getTracks(); + return ResponseEntity.ok(tracksResponse); + } + + @GetMapping("/tracks/{id}") + public ResponseEntity getTrack(@PathVariable Long id) { + TrackSingleResponse response = trackService.getTrack(id); + return ResponseEntity.ok(response); + } +} diff --git a/src/main/java/in/koreatech/koin/domain/BaseEntity.java b/src/main/java/in/koreatech/koin/domain/BaseEntity.java new file mode 100644 index 000000000..37c5f2943 --- /dev/null +++ b/src/main/java/in/koreatech/koin/domain/BaseEntity.java @@ -0,0 +1,27 @@ +package in.koreatech.koin.domain; + +import jakarta.persistence.Column; +import jakarta.persistence.EntityListeners; +import jakarta.persistence.MappedSuperclass; +import jakarta.validation.constraints.NotNull; +import java.time.LocalDateTime; +import lombok.Getter; +import org.springframework.data.annotation.CreatedDate; +import org.springframework.data.annotation.LastModifiedDate; +import org.springframework.data.jpa.domain.support.AuditingEntityListener; + +@Getter +@MappedSuperclass +@EntityListeners(value = AuditingEntityListener.class) +public abstract class BaseEntity { + + @NotNull + @CreatedDate + @Column(name = "created_at", nullable = false, updatable = false) + private LocalDateTime createdAt; + + @NotNull + @LastModifiedDate + @Column(name = "updated_at", nullable = false, updatable = false) + private LocalDateTime updatedAt; +} diff --git a/src/main/java/in/koreatech/koin/domain/Member.java b/src/main/java/in/koreatech/koin/domain/Member.java new file mode 100644 index 000000000..ee9c76d9b --- /dev/null +++ b/src/main/java/in/koreatech/koin/domain/Member.java @@ -0,0 +1,68 @@ +package in.koreatech.koin.domain; + +import jakarta.persistence.Column; +import jakarta.persistence.Entity; +import jakarta.persistence.GeneratedValue; +import jakarta.persistence.GenerationType; +import jakarta.persistence.Id; +import jakarta.persistence.Lob; +import jakarta.persistence.Table; +import jakarta.validation.constraints.NotNull; +import jakarta.validation.constraints.Size; +import lombok.AccessLevel; +import lombok.Builder; +import lombok.Getter; +import lombok.NoArgsConstructor; + +@Getter +@Entity +@Table(name = "members") +@NoArgsConstructor(access = AccessLevel.PROTECTED) +public class Member extends BaseEntity { + + @Id + @GeneratedValue(strategy = GenerationType.IDENTITY) + private Integer id; + + @Size(max = 50) + @NotNull + @Column(name = "name", nullable = false, length = 50) + private String name; + + @Size(max = 20) + @Column(name = "student_number", length = 20) + private String studentNumber; + + @NotNull + @Column(name = "track_id") + private Long trackId; + + @Size(max = 20) + @NotNull + @Column(name = "position", nullable = false, length = 20) + private String position; + + @Size(max = 100) + @Column(name = "email", length = 100) + private String email; + + @Lob + @Column(name = "image_url") + private String imageUrl; + + @NotNull + @Column(name = "is_deleted", nullable = false) + private Boolean isDeleted = false; + + @Builder + public Member(String name, String studentNumber, Long trackId, String position, String email, String imageUrl, + Boolean isDeleted) { + this.name = name; + this.studentNumber = studentNumber; + this.trackId = trackId; + this.position = position; + this.email = email; + this.imageUrl = imageUrl; + this.isDeleted = isDeleted; + } +} diff --git a/src/main/java/in/koreatech/koin/domain/TechStack.java b/src/main/java/in/koreatech/koin/domain/TechStack.java new file mode 100644 index 000000000..624edc356 --- /dev/null +++ b/src/main/java/in/koreatech/koin/domain/TechStack.java @@ -0,0 +1,56 @@ +package in.koreatech.koin.domain; + +import jakarta.persistence.Column; +import jakarta.persistence.Entity; +import jakarta.persistence.GeneratedValue; +import jakarta.persistence.GenerationType; +import jakarta.persistence.Id; +import jakarta.persistence.Lob; +import jakarta.persistence.Table; +import jakarta.validation.constraints.NotNull; +import jakarta.validation.constraints.Size; +import lombok.AccessLevel; +import lombok.Builder; +import lombok.Getter; +import lombok.NoArgsConstructor; + + +@Getter +@Entity +@Table(name = "tech_stacks") +@NoArgsConstructor(access = AccessLevel.PROTECTED) +public class TechStack extends BaseEntity { + + @Id + @GeneratedValue(strategy = GenerationType.IDENTITY) + private Long id; + + @Lob + @Column(name = "image_url") + private String imageUrl; + + @Size(max = 50) + @NotNull + @Column(name = "name", nullable = false, length = 50) + private String name; + + @Size(max = 100) + @Column(name = "description", length = 100) + private String description; + + @Column(name = "track_id") + private Long trackId; + + @NotNull + @Column(name = "is_deleted", nullable = false) + private Boolean isDeleted = false; + + @Builder + private TechStack(String imageUrl, String name, String description, Long trackId, Boolean isDeleted) { + this.imageUrl = imageUrl; + this.name = name; + this.description = description; + this.trackId = trackId; + this.isDeleted = isDeleted; + } +} diff --git a/src/main/java/in/koreatech/koin/domain/Track.java b/src/main/java/in/koreatech/koin/domain/Track.java new file mode 100644 index 000000000..6c731e782 --- /dev/null +++ b/src/main/java/in/koreatech/koin/domain/Track.java @@ -0,0 +1,44 @@ +package in.koreatech.koin.domain; + +import jakarta.persistence.Column; +import jakarta.persistence.Entity; +import jakarta.persistence.GeneratedValue; +import jakarta.persistence.GenerationType; +import jakarta.persistence.Id; +import jakarta.persistence.Table; +import jakarta.validation.constraints.NotNull; +import jakarta.validation.constraints.Size; +import lombok.AccessLevel; +import lombok.Builder; +import lombok.Getter; +import lombok.NoArgsConstructor; + +@Entity +@Getter +@Table(name = "tracks") +@NoArgsConstructor(access = AccessLevel.PROTECTED) +public class Track extends BaseEntity { + + @Id + @GeneratedValue(strategy = GenerationType.IDENTITY) + private Long id; + + @Size(max = 50) + @NotNull + @Column(name = "name", nullable = false, length = 50) + private String name; + + @NotNull + @Column(name = "headcount", nullable = false) + private Integer headcount; + + @NotNull + @Column(name = "is_deleted", nullable = false) + private Boolean isDeleted = false; + + @Builder + private Track(String name) { + this.name = name; + this.headcount = 0; + } +} diff --git a/src/main/java/in/koreatech/koin/dto/TrackResponse.java b/src/main/java/in/koreatech/koin/dto/TrackResponse.java new file mode 100644 index 000000000..97c9db700 --- /dev/null +++ b/src/main/java/in/koreatech/koin/dto/TrackResponse.java @@ -0,0 +1,36 @@ +package in.koreatech.koin.dto; + +import com.fasterxml.jackson.annotation.JsonFormat; +import com.fasterxml.jackson.databind.PropertyNamingStrategies; +import com.fasterxml.jackson.databind.annotation.JsonNaming; +import in.koreatech.koin.domain.Track; +import java.time.LocalDateTime; +import lombok.AllArgsConstructor; +import lombok.Getter; + +@Getter +@AllArgsConstructor(access = lombok.AccessLevel.PRIVATE) +@JsonNaming(value = PropertyNamingStrategies.SnakeCaseStrategy.class) +public class TrackResponse { + + private Long id; + private String name; + private Integer headcount; + private Boolean isDeleted; + + @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss") + private LocalDateTime createdAt; + @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss") + private LocalDateTime updatedAt; + + public static TrackResponse from(Track track) { + return new TrackResponse( + track.getId(), + track.getName(), + track.getHeadcount(), + track.getIsDeleted(), + track.getCreatedAt(), + track.getUpdatedAt() + ); + } +} diff --git a/src/main/java/in/koreatech/koin/dto/TrackSingleResponse.java b/src/main/java/in/koreatech/koin/dto/TrackSingleResponse.java new file mode 100644 index 000000000..61cfa9abf --- /dev/null +++ b/src/main/java/in/koreatech/koin/dto/TrackSingleResponse.java @@ -0,0 +1,104 @@ +package in.koreatech.koin.dto; + +import com.fasterxml.jackson.annotation.JsonFormat; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.databind.PropertyNamingStrategies; +import com.fasterxml.jackson.databind.annotation.JsonNaming; +import in.koreatech.koin.domain.Member; +import in.koreatech.koin.domain.TechStack; +import in.koreatech.koin.domain.Track; +import java.time.LocalDateTime; +import java.util.List; +import lombok.AccessLevel; +import lombok.AllArgsConstructor; +import lombok.Getter; + +@Getter +@AllArgsConstructor(access = AccessLevel.PRIVATE) +public class TrackSingleResponse { + + @JsonProperty("TrackName") + private String trackName; + + @JsonProperty("TechStacks") + private List innerTechStackResponses; + + @JsonProperty("Members") + private List innerMemberResponses; + + public static TrackSingleResponse of(Track track, List members, List techStacks) { + return new TrackSingleResponse( + track.getName(), + techStacks.stream() + .map(InnerTechStackResponse::from) + .toList(), + members.stream() + .map(member -> InnerMemberResponse.from(member, track.getName())) + .toList() + ); + } + + @Getter + @AllArgsConstructor(access = AccessLevel.PUBLIC) + @JsonNaming(value = PropertyNamingStrategies.SnakeCaseStrategy.class) + public static class InnerTechStackResponse { + + private Long id; + private String name; + private String description; + private String imageUrl; + private Long trackId; + private Boolean isDeleted; + @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss") + private LocalDateTime createdAt; + @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss") + private LocalDateTime updatedAt; + + public static InnerTechStackResponse from(TechStack techStack) { + return new InnerTechStackResponse( + techStack.getId(), + techStack.getName(), + techStack.getDescription(), + techStack.getImageUrl(), + techStack.getTrackId(), + techStack.getIsDeleted(), + techStack.getCreatedAt(), + techStack.getUpdatedAt() + ); + } + } + + @Getter + @AllArgsConstructor(access = AccessLevel.PUBLIC) + @JsonNaming(value = PropertyNamingStrategies.SnakeCaseStrategy.class) + public static class InnerMemberResponse { + + private Integer id; + private String name; + private String studentNumber; + private String position; + private String track; + private String email; + private String imageUrl; + private Boolean isDeleted; + @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss") + private LocalDateTime createdAt; + @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss") + private LocalDateTime updatedAt; + + public static InnerMemberResponse from(Member member, String trackName) { + return new InnerMemberResponse( + member.getId(), + member.getName(), + member.getStudentNumber(), + member.getPosition(), + trackName, + member.getEmail(), + member.getImageUrl(), + member.getIsDeleted(), + member.getCreatedAt(), + member.getUpdatedAt() + ); + } + } +} diff --git a/src/main/java/in/koreatech/koin/repository/MemberRepository.java b/src/main/java/in/koreatech/koin/repository/MemberRepository.java new file mode 100644 index 000000000..882a43414 --- /dev/null +++ b/src/main/java/in/koreatech/koin/repository/MemberRepository.java @@ -0,0 +1,12 @@ +package in.koreatech.koin.repository; + +import in.koreatech.koin.domain.Member; +import java.util.List; +import org.springframework.data.repository.Repository; + +public interface MemberRepository extends Repository { + + Member save(Member member); + + List findAllByTrackId(Long id); +} diff --git a/src/main/java/in/koreatech/koin/repository/TechStackRepository.java b/src/main/java/in/koreatech/koin/repository/TechStackRepository.java new file mode 100644 index 000000000..2839ba3c4 --- /dev/null +++ b/src/main/java/in/koreatech/koin/repository/TechStackRepository.java @@ -0,0 +1,12 @@ +package in.koreatech.koin.repository; + +import in.koreatech.koin.domain.TechStack; +import java.util.List; +import org.springframework.data.repository.Repository; + +public interface TechStackRepository extends Repository { + + TechStack save(TechStack techStack); + + List findAllByTrackId(Long id); +} diff --git a/src/main/java/in/koreatech/koin/repository/TrackRepository.java b/src/main/java/in/koreatech/koin/repository/TrackRepository.java new file mode 100644 index 000000000..16207449e --- /dev/null +++ b/src/main/java/in/koreatech/koin/repository/TrackRepository.java @@ -0,0 +1,15 @@ +package in.koreatech.koin.repository; + +import in.koreatech.koin.domain.Track; +import java.util.List; +import java.util.Optional; +import org.springframework.data.repository.Repository; + +public interface TrackRepository extends Repository { + + Track save(Track track); + + List findAll(); + + Optional findById(Long id); +} diff --git a/src/main/java/in/koreatech/koin/service/TrackService.java b/src/main/java/in/koreatech/koin/service/TrackService.java new file mode 100644 index 000000000..b08cdcfe6 --- /dev/null +++ b/src/main/java/in/koreatech/koin/service/TrackService.java @@ -0,0 +1,37 @@ +package in.koreatech.koin.service; + +import in.koreatech.koin.domain.Member; +import in.koreatech.koin.domain.TechStack; +import in.koreatech.koin.domain.Track; +import in.koreatech.koin.dto.TrackResponse; +import in.koreatech.koin.dto.TrackSingleResponse; +import in.koreatech.koin.repository.MemberRepository; +import in.koreatech.koin.repository.TechStackRepository; +import in.koreatech.koin.repository.TrackRepository; +import java.util.List; +import lombok.RequiredArgsConstructor; +import org.springframework.stereotype.Service; + +@Service +@RequiredArgsConstructor +public class TrackService { + + private final TrackRepository trackRepository; + private final MemberRepository memberRepository; + private final TechStackRepository techStackRepository; + + public List getTracks() { + return trackRepository.findAll().stream() + .map(TrackResponse::from) + .toList(); + } + + public TrackSingleResponse getTrack(Long id) { + Track track = trackRepository.findById(id) + .orElseThrow(() -> new IllegalArgumentException("존재하지 않는 트랙입니다.")); + List member = memberRepository.findAllByTrackId(id); + List techStacks = techStackRepository.findAllByTrackId(id); + + return TrackSingleResponse.of(track, member, techStacks); + } +} diff --git a/src/main/resources/application-example.yml b/src/main/resources/application-example.yml new file mode 100644 index 000000000..8b1378917 --- /dev/null +++ b/src/main/resources/application-example.yml @@ -0,0 +1 @@ + diff --git a/src/test/java/in/koreatech/koin/KoinApplicationTest.java b/src/test/java/in/koreatech/koin/KoinApplicationTest.java new file mode 100644 index 000000000..e49beb282 --- /dev/null +++ b/src/test/java/in/koreatech/koin/KoinApplicationTest.java @@ -0,0 +1,13 @@ +package in.koreatech.koin; + +import org.junit.jupiter.api.Test; +import org.springframework.boot.test.context.SpringBootTest; + +@SpringBootTest +class KoinApplicationTest { + + @Test + void contextLoads() { + } + +} diff --git a/src/test/java/in/koreatech/koin/acceptance/TrackApiTest.java b/src/test/java/in/koreatech/koin/acceptance/TrackApiTest.java new file mode 100644 index 000000000..c11cb9e57 --- /dev/null +++ b/src/test/java/in/koreatech/koin/acceptance/TrackApiTest.java @@ -0,0 +1,187 @@ +package in.koreatech.koin.acceptance; + +import static org.springframework.boot.test.context.SpringBootTest.WebEnvironment.RANDOM_PORT; +import static org.springframework.test.annotation.DirtiesContext.ClassMode.BEFORE_EACH_TEST_METHOD; + +import in.koreatech.koin.domain.Member; +import in.koreatech.koin.domain.TechStack; +import in.koreatech.koin.domain.Track; +import in.koreatech.koin.repository.MemberRepository; +import in.koreatech.koin.repository.TechStackRepository; +import in.koreatech.koin.repository.TrackRepository; +import io.restassured.RestAssured; +import io.restassured.response.ExtractableResponse; +import io.restassured.response.Response; +import java.time.format.DateTimeFormatter; +import org.assertj.core.api.SoftAssertions; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.DisplayName; +import org.junit.jupiter.api.Test; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.boot.test.web.server.LocalServerPort; +import org.springframework.http.HttpStatus; +import org.springframework.test.annotation.DirtiesContext; + +@SpringBootTest(webEnvironment = RANDOM_PORT) +@DirtiesContext(classMode = BEFORE_EACH_TEST_METHOD) +class TrackApiTest { + + @LocalServerPort + int port; + + @Autowired + private TrackRepository trackRepository; + + @Autowired + private TechStackRepository techStackRepository; + + @Autowired + private MemberRepository memberRepository; + + @BeforeEach + void setUp() { + RestAssured.port = port; + } + + @Test + @DisplayName("BCSDLab 트랙 정보를 조회한다") + void findTracks() { + Track request = Track.builder().name("BackEnd").build(); + Track track = trackRepository.save(request); + + ExtractableResponse response = RestAssured + .given() + .log().all() + .when() + .log().all() + .get("/tracks") + .then() + .log().all() + .statusCode(HttpStatus.OK.value()) + .extract(); + + SoftAssertions.assertSoftly( + softly -> { + softly.assertThat(response.body().jsonPath().getList(".").size()).isEqualTo(1); + softly.assertThat(response.body().jsonPath().getLong("[0].id")).isEqualTo(track.getId()); + softly.assertThat(response.body().jsonPath().getString("[0].name")).isEqualTo(track.getName()); + softly.assertThat(response.body().jsonPath().getInt("[0].headcount")).isEqualTo(track.getHeadcount()); + softly.assertThat(response.body().jsonPath().getBoolean("[0].is_deleted")) + .isEqualTo(track.getIsDeleted()); + softly.assertThat(response.body().jsonPath().getString("[0].created_at")) + .isEqualTo(track.getCreatedAt().format(DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss"))); + softly.assertThat(response.body().jsonPath().getString("[0].updated_at")) + .isEqualTo(track.getUpdatedAt().format(DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss"))); + } + ); + } + + @Test + @DisplayName("BCSDLab 트랙 정보 단건 조회") + void findTrack() { + Track track = Track.builder().name("BackEnd").build(); + trackRepository.save(track); + + Member member = Member.builder() + .isDeleted(false) + .studentNumber("2019136064") + .imageUrl("https://imagetest.com/asdf.jpg") + .name("박한수") + .position("Regular") + .trackId(track.getId()) + .email("hsp@gmail.com") + .build(); + memberRepository.save(member); + + TechStack techStack = TechStack.builder() + .isDeleted(false) + .imageUrl("https://testimageurl.com") + .trackId(track.getId()) + .name("Java") + .description("Language") + .build(); + techStackRepository.save(techStack); + + ExtractableResponse response = RestAssured + .given() + .log().all() + .when() + .log().all() + .get("/tracks/{id}", track.getId()) + .then() + .log().all() + .statusCode(HttpStatus.OK.value()) + .extract(); + + SoftAssertions.assertSoftly( + softly -> { + softly.assertThat(response.body().jsonPath().getString("TrackName")).isEqualTo(track.getName()); + + softly.assertThat(response.body().jsonPath().getList("Members")).hasSize(1); + softly.assertThat(response.body().jsonPath().getInt("Members[0].id")).isEqualTo(member.getId()); + softly.assertThat(response.body().jsonPath().getString("Members[0].name")).isEqualTo(member.getName()); + softly.assertThat(response.body().jsonPath().getString("Members[0].student_number")) + .isEqualTo(member.getStudentNumber()); + softly.assertThat(response.body().jsonPath().getString("Members[0].position")) + .isEqualTo(member.getPosition()); + softly.assertThat(response.body().jsonPath().getString("Members[0].track")) + .isEqualTo(track.getName()); + softly.assertThat(response.body().jsonPath().getString("Members[0].email")) + .isEqualTo(member.getEmail()); + softly.assertThat(response.body().jsonPath().getString("Members[0].image_url")) + .isEqualTo(member.getImageUrl()); + softly.assertThat(response.body().jsonPath().getBoolean("Members[0].is_deleted")) + .isEqualTo(member.getIsDeleted()); + softly.assertThat(response.body().jsonPath().getString("Members[0].updated_at")) + .isEqualTo(member.getUpdatedAt().format(DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss"))); + softly.assertThat(response.body().jsonPath().getString("Members[0].created_at")) + .isEqualTo(member.getCreatedAt().format(DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss"))); + + softly.assertThat(response.body().jsonPath().getList("TechStacks")).hasSize(1); + softly.assertThat(response.body().jsonPath().getLong("TechStacks[0].id")).isEqualTo(techStack.getId()); + softly.assertThat(response.body().jsonPath().getString("TechStacks[0].image_url")) + .isEqualTo(techStack.getImageUrl()); + softly.assertThat(response.body().jsonPath().getLong("TechStacks[0].track_id")) + .isEqualTo(techStack.getTrackId()); + softly.assertThat(response.body().jsonPath().getString("TechStacks[0].name")) + .isEqualTo(techStack.getName()); + softly.assertThat(response.body().jsonPath().getString("TechStacks[0].description")) + .isEqualTo(techStack.getDescription()); + softly.assertThat(response.body().jsonPath().getBoolean("TechStacks[0].is_deleted")).isFalse(); + softly.assertThat(response.body().jsonPath().getString("TechStacks[0].updated_at")) + .isEqualTo(techStack.getUpdatedAt().format(DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss"))); + softly.assertThat(response.body().jsonPath().getString("TechStacks[0].created_at")) + .isEqualTo(techStack.getCreatedAt().format(DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss"))); + + } + ); + } + + @Test + @DisplayName("BCSDLab 트랙 정보 단건 조회 - 트랙에 속한 멤버와 기술스택이 없을 때") + void findTrackWithEmptyMembersAndTechStacks() { + Track track = Track.builder().name("BackEnd").build(); + trackRepository.save(track); + + ExtractableResponse response = RestAssured + .given() + .log().all() + .when() + .log().all() + .get("/tracks/{id}", track.getId()) + .then() + .log().all() + .statusCode(HttpStatus.OK.value()) + .extract(); + + SoftAssertions.assertSoftly( + softly -> { + softly.assertThat(response.body().jsonPath().getString("TrackName")).isEqualTo(track.getName()); + + softly.assertThat(response.body().jsonPath().getList("Members")).hasSize(0); + softly.assertThat(response.body().jsonPath().getList("TechStacks")).hasSize(0); + } + ); + } +}