Hello Pyramid [Part 1] – Test First

Posted by – December 19, 2012

เคยมองหา framework ทางเลือกที่คล้ายๆ Ruby on Rails บน Python ขอแค่มี MVC  มี config น้อยๆ แต่ถ้าจะปรับ ต้องทำได้ มีการจัดการ Routing และเครืองมือสำหรับเขียน Test ที่สนใจก็มี Django, web2py และ Pyramid ซึ่ง Django ก็ใช้ทำงานอยู่ และ Pyramid ก็ดูเบากว่า web2py เลยเลือกตัวนี้

หลังจากอยู่กับมันได้ 2-3 อาทิตย์ พบว่าเป็น framework ที่ไม่ซับซ้อนอะไรมาก เอกสารค่อนข้างชัดเจน แต่ความยากสำหรับคนฝั่ง Rails อย่างผม คือ ผมขี้เกียจหา ORM ดูอยู่นาน ซึ่งผมเลือก SQLalchemy วัดดวงกับมัน ลองดูจริงๆ ก็ไม่ได้เลวร้ายอะไรมาก แค่ต้องทำความคุ้นเคยกับการอ่านเอกสารนิดหน่อย ตั้งแต่เริ่มเขียนเว็บ อ่านเอกสารมาก็เยอะ เพิ่งเจอว่าเอกสารของ Pyramid มีการเขียน test ในหน้าแรกๆ ของเอกสารเลย ยิ่งประทับใจเข้าไปใหญ่ แค่แอบงงกับการจัดหมวดหมู่ของ Test ของมันนิดหน่อย จริงๆ อยากได้ BDD แบบ RSpec เลย แต่ยังหาไม่ได้

ผมจะเริ่มต้นด้วยการจินตนาการก่อน ว่าผมจะเขียน Test ไปให้ครอบคลุมกับ CRUD ของ Todolist ขำๆ ตัว test ของผมจะต้อง fail แล้วผมจะค่อยๆ implement ไป ทำให้มันผ่าน ซึ่งการเริ่มต้นของ project ขอให้ setup ตาม doc นี้ก่อน พอติดตั้งแล้วจะเจอเครืองมือสำหรับ Test 2 ตัวคือ Unittest กับ Test Coverage โดยตัว Unittest ก็เป็น Unittest ของ Python เอง(หรือ PyUnit) ส่วนตัว Test Coverage เป็นการรวมตัวของ Coverage ที่เอาไว้วัดว่า code ถูกเรียกใช้ขนาดไหนเมื่อเทียบกับ code ทั้งหมด กับ nose ที่จะทำให้เรากำหนดว่าเราจะเรียก test file ไหนบ้าง ก่อนที่จะไปดูตัวอย่าง ต้องมาพููดถึงระดับหรือมุมมองการ test ก่อน ใน Pyramid มันแบ่งเป็น 3 แบบคือ

  • Unit test คือการ test ในส่วนย่อยสุด(unit) เช่น function เฉพาะงานหรือตัวแปร
  • Integration test คือการ test ที่รวมสิ่งทีเ่ป็น unit ข้างบน มา test รวมกัน ซื่งในตัวอย่างจะเป็น Integration test ทั้งหมด
  • Functional test คือการ test เหมือน integration test แต่ run ด้วย code จริง มี stack กี่ชั้นก็ทำงานหมด ไม่มีการ mock/stub ไว้ก่อน

My test cases

จากนั้น มานึกดูว่า test เราควรจะมีส่วนอะไรบ้าง..

  • C – Create ควรจะส่ง request ไปที่ function แล้วคืนค่ามาเป็น dict ที่บรรจุข้อมูลของ todo ที่สร้าง
  • R – Read(also Edit and list) ควรจะ get ไป server แล้วคืนค่ามาเป็น dict ของ id หรือ list ของ dict ของ todo
  • U – Update ใจจริงอยากให้เป็น restful ด้วยการทำให้เป็น put แตผมเพิ่งเริ่ม ท่าพลิกแพลงไว้คราวหลัง ตอนนี้ขอเป็น post ชุดของข้อมูลทีจะ update แล้วคืนค่ามาเป็น dict ของ todo ที่ update แล้ว
  • D – Delete ให้เป็น post ไป server แล้วคืนค่ามาเป็น id ของัตวที่ถูกลบ

สังเกตดู สิ่งที่ผมพิจารณาคือ มันคืนค่ามาเป็นอะไรใน function ที่เตรียมไว้ ซึ่งจริงๆ มันควรจะมี http status เป็น 200 หรือ ข้อมูลที่คืนมาควจะมี content-type เป็น json ซึ่งจริงๆ ตรงส่วนนี้จะมีเครืองมีที่จำลอง http request จริงๆ ส่งไป test ใน functional test อีกที คืิดว่าคงเห็นภาพที่มันพยายามแบ่ง Integration/Functional test ไว้แล้ว

Set up and Tear down

อีกสักนิด จะขาดไม่ได้ ต้องแนะนำสิ่งทีจำเป็นใน Unittest ก่อน… set up/tear down เป็นพื้นที่สำหรับใส่ code ทีจะให้ถูกเรียกใช้ตอนที่เริ่ม test กับหลัง test ซึ่งโดยทั่วไป มักจะเป็นการเริ่มคำสั่งเตรียม stack ของการ test หรือใส่ชุดข้อมูลสำหรับ test ลงใน database ใน set up พอ test เสร็จแล้ว ก็ต้องเคลียร์ออกที่ใส่ไป ใน tear down หน้าตาประมาณนี้

class TestIntegrationTodolist(unittest.TestCase):
    def setUp(self):
        self.config = testing.setUp()
        from sqlalchemy import create_engine
        #engine = create_engine('sqlite:///todolist.sqlite')
        engine = create_engine('postgresql://dev:dev@localhost:5432/todolist_test')
 
        DBSession.configure(bind=engine)
        Base.metadata.create_all(engine)
        # the transaction commited after added so rolling back doesnt work on Postgres
        #with transaction.manager:
        instances = (
            Todo(task='Second task', priority=0),
            Todo(task='Thrid task', priority=5),
            Todo(task='First task', priority=10),
            Todo(task="Done task", priority=5, done_at=datetime.now())
        )
        DBSession.add_all(instances)
 
    def tearDown(self):
        DBSession.remove()
        testing.tearDown()

จากตัวอย่างข้างบน จะเริ่มต้นจากการต่อเข้า PosgreSQL จากนั้นก็เชื่อมต่อระหว่าง Pyramid กับ SQLAlchemy แล้วจึงใส่ code ในส่วนของการเตรียมขอ้มูลสำหรับทดสอบลงไป พอเทสจบ ก็เคลียร์ค่าเก่าไป

Read

การ read ใน todolist ของผม จะมีแค่ 1 งานเท่านั้น คือการแสดงรายการใน todolist ทั้งหมด สิ่งที่ผมสนใจคือ พอ request แล้ว มันควรจะคืนค่ามาเป็นชุดของ dict ทีบรรจุข้อมูลของ todo แต่ละอัน

    def test_index_pass(self):
        """ test_index_pass """
        from todolist.controllers.todos import index
        request = testing.DummyRequest()
        response = index(request)
        self.assertEqual(len(response['todos']), 3)
        self.assertEqual(len(response['done_todos']), 1)
        # test ordering
        self.assertEqual(response['todos'][0].task, "First task")
        self.assertEqual(response['todos'][2].task, "Second task")

ก็ตรงไปตรงมา สิ่งที่ดูไม่เหมือนคนอื่นเลยคือจะมี done_todos ซึ่งจริงๆ แล้วผมตั้งใจว่าจะแยกตัวที่ทำไปแล้ว ไปไว้อีกกลุ่มนึง เลยแยกไว้ และทำการใส่ค่าเริ่มต้นจากตอน setup ด้วยการใส่ done_at เป็นการบอกว่าตัวนี้ทำแล้ว

ความสะดวกอย่างนึงของ Pyramid คือ มีการจำลอง request ซึ่งง่ายมากด้วย testing.DummyRequest() ซึ่งถ้าเป็นการ post จะมีในตัวอย่างถัดไป

Create
    def test_create_pass(self):
        """ test_create_pass """
        from todolist.controllers.todos import create
        params = {'task':'New task', 'priority':1}
        request = testing.DummyRequest(params=params, post=params)
        response = create(request)
        self.assertTrue(response['id'])
        self.assertEqual(response['task'], params['task'])
        self.assertEqual(response['priority'], params['priority'])
 
    def test_create_fail(self):
        """ test_create_fail """
        from todolist.controllers.todos import create
        params = {'task':"", 'priority': "low"}
        request = testing.DummyRequest(params=params, post=params)
        response = create(request)
        self.assertTrue(response['errors'])
        self.assertEqual(len(response['errors']['priority']), 1)
        self.assertEqual(len(response['errors']['task']), 1)
        self.assertEqual(response['errors']['task'], ['Please enter a value'])

ส่วนของ create เนี่ย ผมเตรียม test ไว้ 2 กรณี คือ ผ่าน กับ ไม่ผ่าน โดยถ้าไม่ผ่านจะมีข้อความเตือนหน่อยนึง อย่างกรณีนี้ ผมใส่เป็นข้อความเปล่าๆ ไป มันควรจะบอกผมว่า ผมควรใส่ค่าอะไรไปหน่อยนะ

สว่น priority ไว้บอกความเร่งด่วน ค่อนข้างตรงไปตรงมา

ตัวอย่างการ post ด้วย DummyRequest ก็แค่ใส่ค่า post ใน parameter ตอนสร้าง DummyRequest เท่านั้นเอง ส่วน parameter จะมีอะไรบ้าง ก็ลองเปิดอ่าน doc ดูครับ จะเห็นตัวอย่างการจำลอง session ด้วย

Update
    def test_update_pass(self):
        """ test_update_pass """
        from todolist.controllers.todos import update
        params = {'task':'Updated task', 'priority':1}
        # provide the todo with id
        todo = DBSession.query(Todo).first()
        request = testing.DummyRequest(params=params, matchdict={'id':todo.id}, post=params)
        response = update(request)
        updated_todo = DBSession.query(Todo).filter_by(id=todo.id).one()
        self.assertEqual(response['task'], params['task'])
        self.assertEqual(updated_todo.task, params['task'])
 
    def test_update_fail(self):
        """ test_update_fail """
        from todolist.controllers.todos import update
        # test query not found
        request = testing.DummyRequest(params={}, matchdict={'id':1}, post={})
        response = update(request)
        self.assertEqual(response['errors'], "No todo id: 1")
 
        # test validation
        params = {'task':"", 'priority': "low"}
        todo = DBSession.query(Todo).first()
        request = testing.DummyRequest(params=params, matchdict={'id':todo.id}, post=params)
        response = update(request)
        self.assertTrue(response['errors'])
        self.assertEqual(len(response['errors']['priority']), 1)
        self.assertEqual(response['errors']['task'], ['Please enter a value'])
        self.assertEqual(response['errors']['priority'], ['Please enter an integer value'])

เหมือนของ create เลย แตต่างกันตรงที่ตอน test การ validate  ข้อมูล ผมคิดว่าจะให้ priority เป็นตัวเลข แต่ใน test นี้ผมดันใส่เป็นข้อความไป มันควรจะบอกสิว่าให้ใส่ตัวเลขนะ

Delete
    def test_delete_pass(self):
        """ test_delete_pass """
        from todolist.controllers.todos import delete
        todo = DBSession.query(Todo).first()
        request = testing.DummyRequest(params={},matchdict={'id':todo.id}, post={})
        response = delete(request)
        todo_count = DBSession.query(Todo).count()
        self.assertIsNot(todo, DBSession.query(Todo).first())
        self.assertEqual(response['messages'], '%s has been deleted' % todo.task)
        self.assertEqual(todo_count, 3)
 
    def test_delete_fail(self):
        """ test_delete_fail """
        from todolist.controllers.todos import delete
        # test query not found
        request = testing.DummyRequest(params={}, matchdict={'id':1}, post={})
        response = delete(request)
        self.assertEqual(response['errors'], "No todo id: 1")

สำหรับ 2 กรณีอีกเช่นกัน แต่การ test กรณีที่ไม่ผ่าน ก็จะมีข้อความอะไรเล็กหน้อยมาบอกว่าถ้าหากถูกลบไปแล้ว ถ้ากรณีผ่าน จำนวนทั้งหมดควรจะถูกลดไปด้วย

จาก test ทั้งหมดข้างบนเนี่ย พอรันด้วย nosetest หน้าตาจะเป็นแบบนี้

Failed nosetest

Failed nosetest

จะเห็นถึง error นิดหน่อยคือ พยายามจะ import มา แตเรายังไมได้ implement มันก็เลยพัง
อีกส่วนคือหน้าตาของ code coverage

Post ต่อไปจะ implement แล้วครับ

0 Comments on Hello Pyramid [Part 1] – Test First

Respond

Respond

Comments

Comments