nKiNk / cub3D_map_tester

- 42seoul cub3D 프로젝트의 맵 유효성 체크기능 tester

cub3D_map_tester

-test for the cub3D project at 42 school 42. (cursus42, june 2020)

안녕하세요~! 🖐 이 프로그램은 cub3D 프로그램이 cub3D 프로젝트의 맵 제약조건 요구사항을 잘 충족하는지 체크하는데 도움을 주기 위해 만들어졌습니다. 하단 설명을 참고하시어 코드작성 or 동료평가시 활용해보세요 🙂

🍉 개요

• 이 프로그램은 invalid map 파일을 당신의 cub3D 파일에 전달합니다.
• 오류가 있는지 확인하기 위해서는 Return 메세지를 직접 확인해주셔야 합니다.
  • 만약 예외처리가 잘 되어있다면, 당신이 의도한 방식대로 error 메세지를 출력할 거에요.
  • 만약 예외처리가 잘 되어있지 않다면, 아래 두가지 동작이 예상됩니다.
    1. segfault, sigabort 등등 예기치 않은 error 메세지가 출력되는 경우
    2. cub3D가 작동해버리는 경우
• invalid map는 maps 디렉토리 안에 있습니다. 참고하여 예외처리 진행하시면 됩니다.

🍉 설치 및 실행

1. Move to directory where your cub3D file exist
2. Clone this repository

   git clone https://github.com/humblEgo/cub3D_map_tester.git

3. Move to cub3D_map_tester directory

   cd cub3D_map_tester

4. Execute test_map_valid_function.sh

   ./test_map_valid_function.sh

시작할 때 count down이 거슬릴 경우

-f 옵션을 넣어서 count down을 생략할 수 있습니다.

./test_map_valid_function.sh -f

실행시 directory tree

결과적으로 test_map_valid_function.sh 의 상위폴더에 cub3D 실행파일이 있으면 됩니다.

.
├── cub3D
├── _cub3D_map_tester
|   ├── test_map_valid_function.sh
|   ├── README.md
|   ├── _images
|   └── _maps
|   ├── ...
└── ...

🍉 TEST COVERAGE

test파일은 'test_{TYPE}{NUMBER}.cub' 형식으로 되어있습니다. 각 TYPE, NUMBER별 케이스는 아래와 같습니다.

요소	요소2	R	W	FC	I	MAP
형식 개수	0개	6	6	7	4
	2개	7	2	6	3
인자 개수	0개	8	7	11	5	18
	1개	2
	2개		3	5	6	19,20
	3개	1
형식 값	오타	4	5	8	7
	중복	5	1	1	2
인자 값	오타	3	4	3,9,10,2,12,13	1	1
	범위초과			4
player개수	0개					3
	2개 이상					2, 13
open map	no tab					4,5,6,7,8,9,10,11,12,21,22,23,24,25,26,27
	with tab					17
out of map						14, 15
맵 위치						16

ex) R 640 480을 예로들면 R은 '형식'이라 간주하고 640 480은 '인자'라고 간주했습니다. 따라서 test_R1의 경우 인자개수가 3개인 테스트 맵파일입니다.

🍉 기타 테스트케이스

❗ R 123456789 480 이나 R 480 123456789로 주어져서 렌더링해야하는 사이즈가 너무 클 경우의 처리가 적절한지 따로 체크해주세요!

• 이 경우 에러로 처리하거나 에러로 처리하지 않고 화면에 맞게 조정하여 프로그램을 실행시키는 경우 모두 적절하다는 의견을 받아들여 에러테스트케이스에서 제외했습니다. 따로 실행해보고 적절히 처리되었는지 확인해보세요.

❗ F 255, 255, 255로 주어지는 등 인자 사이에 공백이 있는 경우에는 제대로 작동하도록 처리해주세요!

🍉 참고사항

1. 쉘스크립트로 테스트 자동화는 처음 시도해보는 것이라 더 학습하고 싶습니다. 쉘스크립트 개선에 관하여 PR이나 ISSUE 남겨주세요! 감사히 배우겠습니다🙏

2. 맵 테스트케이스 추가를 원하신다면 역시 PR이나 ISSUE 남겨주시면 반영하겠습니다.

3. 서브젝트 자체도 완벽하지 않다보니 '어느 수준까지 예외처리해야하는지' 여부를 따로 판단해보시길 추천드립니다. 개인적으로는 동료평가시 디펜스가 가능한지 여부를 기준으로 결정하면 좋지않을까 싶어요 :)

4. cub3D로 고통받고 계시다면, taelee42님의 mlx_example을 참고해보세요.

기타 문의할 사항이 있으시다면 Slack ID iwoo로 DM 날려주세요~ :)

🍉 기여해주신 분

이 테스터를 만드는데 기여해주신 분들입니다. 기여해주셔서 감사합니다!! 👏👏

• jwon님
• eunhkim님
• sjaehyeo님