Skip to content

Debug It! 실용주의 디버깅 : 소프트웨어 개발자가 꼭 알아야 할 디버깅의 정석

Debug It! 실용주의 디버깅 : 소프트웨어 개발자가 꼭 알아야 할 디버깅의 정석 published on Debug It! 실용주의 디버깅 : 소프트웨어 개발자가 꼭 알아야 할 디버깅의 정석에 댓글 없음

대학교 졸업 후 처음으로 소프트웨어 개발 일을 했을 때 한 일은 주로 기존 솔루션(레거시)을 유지보수하는 일이었다. 그렇다 보니 문제를 해결하는 과정에서 디버깅을 해야 할 일이 많았고, 자체적으로 만들어진 테스트가 별로 없었기에 기존 코드를 디버깅하면서 코드 기반과 친해져야만 했다. 지금은 개발 중에도 테스트 우선 개발이나 단위 테스트를 경향이 점점 많아지곤 있지만 레거시 소프트웨어의 문제를 테스트라는 안전망 없이 디버깅에 의존해서 해결해야 하는 일은 그 당시 나한테는 쉽지 않은 일이었다.

지금도 그렇지만 학교에서는 디버깅 따위는 가르쳐주지 않는다. 소프트웨어 공학이나 프로그래밍 언어 수업을 들었어도 CS 이론을 배우기마저 급급한 나머지 정작 실무 현장에서 반드시 필요한 지식이나 훈련 따위는 감히 상상조차 하지 못하는 상황이었다. 그렇다 보니 디버깅 같은 것들은 직접 책이나 회사 선배들에게 배워야 하는 것이다. 그마저도 당면한 회사 업무에 초점을 맞춰 배우다 보니 좀 더 체계적인 이론적 지식이나 훈련을 하지 못했던 것이 아쉽게 느껴진다.

이 책을 읽는 내내 이런 생각이 들었다. 회사에서 일할 때 이런 책을 미리 읽어봤더라면 훨씬 더 업무를 체계적으로 처리할 수 있었겠다는 생각이 든다. 디버깅하면서 막혔던 부분이라든가 주먹구구식이 아닌 좀 더 정교한 디버깅 방법론을 배울 수 있었으리라는 생각, 그리고 이 책에서 택한 실용주의적인 디버깅 체계/접근법을 익혔다면 좋았으리라는 생각이 들었다. 요즘엔 업계에서 테스트가 강조되는 분위기라 디버깅의 중요성이 차지하는 위치가 예전만큼 못 하다곤 하지만 그럼에도 디버깅이라는 것은 프로그래머가 반드시 익혀야 할 필수 기술이 아닌가 싶다. 혹자는 디버깅이 Art에 가깝다고 했는데, 처음에는 이해하지 못했지만 지금은 이 책을 읽고 나서 조금은 이해할 수 있을 것 같다.

지금 코드의 구조도 안 좋고, 테스트나 문서화도 제대로 안 돼 있을 수 있지만 꽤 오랫동안 제품으로 시장에 나가 있었다면 대부분의 경우에는 제대로 실행될 것이다. 즉, 문제 도메인에 대한 엄청난 지식이 코드에 들어 있을 것이고, 이런 지식은 다른 식으로는 기록하기가 거의 불가능하다.
이런 지식은 미묘한 것이라 요구사항 분석으로 다시 찾아내기 어렵다. 예를 들어 ‘네, 보통은 그렇게 되는 게 맞습니다만 이런 특수한 타입을 기록하기 위해서는 다르게 동작해야 합니다’와 같이 제품에서 계속 튀어나오는 특수한 경우는 소소코드 외에는 문서를 포함한 그 어느 곳에도 기록돼 있지 않을 것이다. 소프트웨어를 다시 작성할 때 조심하지 않으면 이미 겪었던 문제들을 다시 겪으면서 계속 생기는 회귀를 고쳐야 할 것이다. (p.234)

로그를 이용해 디버깅하는 법

로그를 이용해 디버깅하는 법 published on 로그를 이용해 디버깅하는 법에 댓글 없음

로깅은 로그라고 하는 정보성 기록을 만들어도록 시스템을 작성하는 실천법입니다. 임시 코드 출력(Printlining)은 간단하고, 대개 임시로 쓸 로그를 만들어내는 것입니다. 초보자는 프로그래밍 지식이 제한적이기 때문에 로그를 이해하고 사용해야 하고, 시스템 아키텍트는 시스템의 복잡성 때문에 로그를 이해하고 사용해야 합니다. 로그에서 제공하는 정보의 양은 설정 가능해야 합니다(이상적인 경우 프로그램이 실행 중인 동안에도). 일반적으로 로그는 세 가지 기본적인 이점을 제공합니다.

  • 로그는 재현하기 힘든 버그(배포 환경에서는 발생하지만 테스트 환경에서는 재현할 수 없는 것과 같은)에 관한 유용한 정보를 제공할 수 있습니다.
  • 로그는 성능과 관련된 통계와 데이터를 제공할 수 있습니다(예: 두 문장 사이에 소요된 시간).
  • 로그를 설정할 수 있는 경우, 예상치 못한 특정 문제를 디버깅하기 위해 해당 문제만를 해결하는 코드를 수정 및(또는) 재배포할 필요 없이 일반적인 정보를 확보할 수 있습니다.

로그에 출력하는 내용의 양은 정보와 간결성 사이에서 절충 가능합니다. 정보가 너무 많으면 로그를 처리하는 비용이 높아지고 스크롤의 압박이 생겨서 원하는 정보를 찾기가 힘들어집니다. 반면 정보가 너무 적으면 필요한 정보가 포함돼 있지 않을지도 모릅니다. 이러한 이유로 로그에 출력하는 내용을 설정 가능하게 만들면 아주 유용합니다. 대개 로그상의 각 레코드는 소스 코드 상의 위치, 실행된 스레드, 정확한 실행 시간, 그리고 공통적으로 특정 변수의 값, 여유 메모리의 양, 데이터 객체의 수 등과 같이 추가적인 유용한 정보를 파악하게 해줍니다. 이러한 로그문은 소스코드 도처에 흩어져 있으며, 특히 주요 기능 지점과 위험성 있는 코드 주변에 지정돼 있습니다. 각 로그문에는 레벨을 할당할 수 있고 시스템이 현재 해당 레벨로 설정돼 있는 경우에만 로그 레코드를 출력할 것입니다. 로그문은 예상되는 문제를 해결하도록 설계해야 합니다. 성능 측정의 필요성을 예상해 보십시오.

영구적인 로그가 있다면 로그 레코드 측면에서 임시 코드 출력(Printlining)을 해볼 수 있으며, 아마도 그러한 디버깅 문장의 일부는 영구적으로 로깅 시스템에 추가될 것입니다.

오류를 제거하는 법

오류를 제거하는 법 published on 오류를 제거하는 법에 댓글 없음

지금까지는 일부러 프로그램 실행을 검사하는 활동과 오류를 고치는 활동을 나눴습니다. 하지만 물론 디버깅은 버그를 제거하는 것을 의미하기도 합니다. 이상적인 경우라면 코드를 완벽하게 이해하고 오류와 그것을 고치는 방법이 훤히 드러나는 ‘아하!’라고 깨닫는 순간에 도달해야 할 것입니다. 하지만 프로그램은 여러분이 명확하게 알기 힘든, 불충분하게 문서화된 시스템을 사용하는 경우도 있을 것이므로 이러한 순간이 늘 오지는 않을 것입니다. 어떤 경우에는 코드가 너무 복잡해서 완벽하게 이해하지 못하는 경우도 있을 것입니다.

버그를 고칠 때는 가장 작은 부분만 변경해서 해당 버그를 고치고 싶을 것입니다. 개선이 필요한 다른 부분이 보일지도 모릅니다. 하지만 그것들을 동시에 고치지는 마십시오. 한 번에 딱 하나만 변경하는 과학적 방법론을 활용하려고 하십시오. 이를 위한 최선의 방법은 버그를 손쉽게 재현한 다음, 고친 코드를 올바른 자리에 놓고, 프로그램을 다시 실행해서 버그가 더는 존재하지 않는지 관찰하는 것입니다. 물론 때로는 한 줄 이상을 변경해야 하겠지만 그럼에도 개념적으로는 단 하나의 최소한의 변경사항을 적용해 버그를 고쳐야 합니다.

간혹 여러 개의 버그가 하나로 보일 때도 있습니다. 버그를 정의하고 그것을 한번에 고치는 것은 여러분에게 달려 있습니다. 때로는 프로그램이 어떻게 동작해야 하거나 원 제작자가 의도한 바가 명확하지 않은 경우도 있습니다. 이 경우 경험과 판단을 발휘해 해당 코드에 여러분만의 의미를 부여해야 합니다. 프로그램이 어떻게 동작해야 할지를 결정하고 그것을 주석으로 남기거나 다른 어떤 방법으로 분명히 밝힌 다음 코드가 여러분이 의미한 바를 따르게 하십시오. 이는 맨 처음에 원래의 함수를 작성하는 것보다 더 어려운 중급 또는 고급 기술이며, 현실 세계는 깔끔하게 맞아떨어지지 않을 때가 많습니다. 어쩌면 재작성할 수 없는 시스템을 고쳐야 할 수도 있습니다.