dongjinmedia / algospot

algospot.com, forum + online judge for Korean programming contestants

알고스팟 개발 시작하기

알고스팟은 수많은 패키지들과 서버들이 합쳐져 돌아가고 있다. 따라서 이들을 각각 개인 서버에 셋업해 개발하는 것보다는, 가상머신을 이용하고 가상머신을 쉽게 셋업해 줄 수 있는 도구를 이용하기로 하자. 알고스팟의 공식 개발 환경은 vagrant를 이용한다. vagrant는 VirtualBox, VMWare 등의 가상화 도구를 커맨드 라인에서 사용하기 쉽게 포장해 둔 것이다.

필요한 도구들

아래 도구들이 Host 에 설치되어 있어야 한다.

• Vagrant: 사용중인 운영체제 용을 다운받는다.
• VirtualBox: 가상 머신을 돌리기 위한 소프트웨어. VMWare, 리눅스의 경우 LXC를 이용해도 되지만 아직 확인해 보지 못했다.
• Ansible: 가상 머신에 패키지를 깔고 셋업하는 과정을 자동화하는 소프트웨어.

체크아웃에서 개발 서버 돌리기까지

1. 먼저 git repository 를 클론하고

    $ git clone --recursive https://github.com/jongman/algospot.git
    $ cd algospot
   

2. 가상 머신을 띄운다. 이 명령어는 가상 머신 이미지를 다운받고, 필요한 패키지를 깔고, 데이터베이스와 기타 서버들을 셋업해 준다. (테터링 중에는 쓰지말자)

    $ make init
   

3. 웹브라우저에서 http://localhost:8080/ 을 연다. 새 사용자를 만들거나 admin/admin으로 로그인할 수 있다.

4. 다음부터는 ansible 설정 등에 의해 서버 환경이 변경된 사항이 있다면, 아래 명령어를 통해 패키지 설치/셋업 등을 자동으로 수행할 수 있다.

    $ vagrant provision
   

개발하기

1. 코드를 변경한 이후에는 다음 명령어를 내려 웹서버에 코드를 리로드한다.

    $ make restart-uwsgi
   

2. 이것이 귀찮을 경우 다음 명령을 내려 개발 서버를 연다. 개발 서버는 코드가 변경될 시 자동 리로드되므로 개발이 간편해진다. 개발 서버는 http://localhost:8000/ 에서 접근할 수 있다.

    $ make runserver
   

새 언어 바인딩 추가하기

1. 언어 바인딩은 www/judge/languages/언어명.py에 추가하면 된다.

2. 컴파일 언어의 경우 cpp.py, 인터프리팅 되는 언어의 경우 py.py 를 참고해 작성한다.

3. 가상 머신에 컴파일러를 설치하는 과정을 ansible/single_box.yml에 추가한다. 이 파일은 앤시블 플레이북으로, 서버를 자동으로 설정할 수 있도록 한다.

4. 새 언어 바인딩을 추가한 이후, 다음 명령을 내려 웹서버와 채점 대몬을 재시작한다.

    $ make restart-uwsgi && make restart-celeryd
   

문제 해결하기

1. 문제가 생길 경우 다음 명령을 내려 가상 머신에 ssh 로 접속할 수 있다.

    $ vagrant ssh
   

2. 다음 명령을 내리면 장고 모델과 객체들에 접근할 수 있는 쉘에 접근할 수 있다.

    $ make shell
   

3. 다음 명령을 내리면 가상 머신 내의 DB 쉘에 접근할 수 있다.

    $ make dbshell
   

4. 채점 서버에 문제가 있을 경우 다음 커맨드를 통해 VM의 채점 서버를 중단하고, 채점 서버를 콘솔 모드로 돌리면서 채점 서버의 로그를 볼 수 있다.

    $ make stop-celeryd
    $ make celeryd-console
   

커밋하기

프로젝트에 새 기능을 추가하거나 버그를 고치려면 다음과 같은 과정을 밟는다.

1. 프로젝트 홈페이지의 오른쪽 위 Fork 버튼을 이용해서 프로젝트를 fork 한다. 그러면 GitHub에 algospot 프로젝트의 개인 복사본이 생긴다.
2. 위 과정을 거쳐 해당 프로젝트를 로컬에 클론한다.
3. 로컬에서 적절히 수정한 뒤 커밋해서 GitHub의 개인 프로젝트로 푸시한다.
4. 개인 프로젝트 홈페이지에서 Pull Request 를 통해 jongman 에게 Pull Request 를 보낸다.
5. jongman 이 Pull Request를 읽고 해당 프로젝트를 가져와 jongman 의 프로젝트로 머지한다.
6. -끗-

좀더 자세한 설명은 github의 매뉴얼 페이지에서 볼 수 있다.

Troubles

• "The SSH connection was unexpectedly closed by the remote end."
  • Vagrant up 명령어에서 위와 같은 명령어가 나온다면 놀라지 말고 vagrant reload를 해주면 된다.