/Scala-Project-Template

Study Programming In Scala with ScalaTest

Primary LanguageScala

Scala 프로젝트 기본 템플릿

목표

  • 스터디 혹은 프로젝트에 사용할 스칼라 기본 프로젝트 생성 시 반복되는 스칼라 프로젝트 환경의 기본적인 틀 제시
  • SBT, Eclipse(Scala IDE), Git, ScalaTest, Scalaz 를 지원

사용법

사전 준비

  1. SBT 설치
    • 사용한 SBT 버전은 0.11.2
      • Homebrew 등을 이용하기 보다는 직접 다운로드 후 설치를 권장
    • SBT wiki에 제시된 내용대로 ~/bin/sbt 생성
      • 설치 시 콘솔에서의 한글 사용을 위해 file.encoding=UTF-8을 추가함
      • java -Xmx512M -Dfile.encoding=UTF-8 -jar `dirname $0`/sbt-launch.jar "$@"

프로젝트 템플릿 가져오기

  1. 바로 git clone 후 사용하는 것에 비해 다소 번거롭지만 Scala Project Tempalte의 업데이트를 고려해 다음과 같이 할 것을 권한다.

  2. 고유한 프로젝트 폴더 생성 후 git init

  3. git remote 로 원격지(template) 추가.

     git remote add template git@github.com:nephilim/Scala-Project-Template.git

  4. 다음 명령으로 github의 Scala-Project-Template을 로컬의 project-template 브랜치로 git fetch

     git fetch template

  5. 로컬 추적 브랜치(project-template) 생성

     git checkout -b project-template template/master

  6. 필요시 master 브랜치와 project-template 브랜치를 merge

     git merge project-template

  7. 향후 Scala-Project-Template이 update 되면 git fetch template 후 내용을 확인하고, 적절히 merge함

SBT 프로젝트 설정

  1. build.sbt 내용 변경

    • 작성하려는 프로젝트 명, Scala 버전, 의존 라이브러리 등을 수정함
    • 기본적으로 다음과 같은 라이브러리의 의존성이 추가되어 있음
      1. ScalaTest - 테스트
      2. Scalaz - commons 유틸리티 모음
    • 사용자 라이브러리는 기존 라이브러리와 같은 groupId % artifactId % version 형식으로 build.sbt에 추가하면 됨
    • 기본 Repository로 Sonatype's Maven repository 를 이용함

  2. 프로젝트 디렉토리에서 sbt 실행

    • sbt

  3. sbt 콘솔에서 eclipse 프로젝트 생성(ScalaIDE 사용시)

    • eclipse with-source=true
    • with-source 옵션을 추가하면 eclipse에서 의존 라이브러리의 소스를 볼 수 있게됨

  4. 테스트 수행을 위한 sbt 명령어

    • test 수행
    • 예제 및 문서(필요 시 삭제)
      • Sample로 PIS 17장 관련 테스트 케이스가 들어있음
      • test폴더에 안내 문서(SAMPLE) 포함
    • test-only ${테스트 대상 클래스명} 도 가능

  5. eclipse에서 프로젝트 import

    • import > exisiting project into workpace

  6. .git 및 README.md 삭제

    • 새로운 프로젝트를 시작하기 위해 template관리를 위한 내용은 삭제한다
    • template project는 backup을 만들어 두면 편리하다.

Scala-Project-Template 작업 내역

본 프로젝트는 아래 제시된 작업 내역을 반영한 결과물임

  1. 프로젝트 생성
    • build.sbt
      • 기본 프로젝트 정보 추가
      • 의존 라이브러리 추가
        • 테스트를 위해 ScalaTest 추가
        • libraryDependencies += "org.scalatest" % "scalatest_2.9.1" % "1.6.1" % "test"
        • Scalaz 라이브러리 추가
        • libraryDependencies += "org.scalaz" %% "scalaz-core" % "6.0.4"%
    • sbteclipse plugin 설치
      • SBT를 eclipse 프로젝트로 만들어 주는 플러그인
      • ${PROJECT_ROOT}/project/plugin.sbt에 sbteclipse플러그인 의존성 추가
      • eclipse sbt plugin을 설치하기 위해 plugin.sbt에 다음 한 줄 추가
        • addSbtPlugin("com.typesafe.sbteclipse" % "sbteclipse-plugin" % "2.0.0-M3")
        • 당연한 말이지만, sbteclipse 버전은 향후 변경될 수 있음
  2. Git 설정
    • .gitignore 작성
      • SBT 설정과 소스 파일 외 불필요한 내용은 git에 반영하지 않음

테스트 관련

  • 학습 테스트 작성 시 BDD 스타일을 사용해 테스트 내용을 기록하면 좋을 듯함
    • 스터디 내용을 테스트 케이스로 공유하는 것도 좋은 방법!
  • test 의존 라이브러리로 설정한 ScalaTest의 Spec을 이용하면 BDD 스타일의 Test Case를 작성 가능
  • ScalaTest의 Spec 사용법은 다음의 Quick Start 링크를 참고
  • pis.chap17.m01.StringOpsSpec 을 참고해도 됨
  • 아직 테스트 작성 시 한글 메세지를 어떤 형식으로 작성할 것인가("given, when, then", 각종 matcher...)는 고민 중입니다.
    • 제안 요망