코드에 주석만 변경했을 때 실제 코드 변경이 없는지 확인하는 법

Question

딱히 정답은 없는 질문입니다. 현업 계시는 능력있는 분들께 얻고자 하는 조언입니다. 개인적으로 이 문제를 여러번 접해서, 다른 사람들은 어떻게 접근하나 궁금하기도 하고요.프로젝트 막바지에, 최종 버전 코드 봉인하고 문서화만 하는 단계라고 해봅시다. 문서도 워드프로세서나 UML, md 등으로 열심히 작성하고, 동시에 코드에는 주석만 다는 작업을 한다 하면, 커밋하기 전에 수정한 소스가 기계코드 상이나 바이트코드, IR 상으로 전혀 수정이 없는지 확인하는 방법이 어떤 것이 있을까요.js는 minifier를 쓰거나, node 명령으로 바이트코드를 뽑아볼 수 있더군요. 자바, 파이선, C#도 모두 목적파일을 디스어셈블 하는 툴이 있고, 전통적인 rust나 c/c++도 컴파일한 목적파일을 objdump로 어셈블러를 뽑아서 diff 해보는 방법으로 확인하는 식으로 확인했었습니다.보안적인 이유로 주소 랜덤화되고, 빌드id 다르게 나오는 것만 빼면 그리 어렵지 않았는데, 그래도 개인적으로 이게 마음에 들지 않아요. 소스 컴파일하고, 디컴파일하고, diff 떠보고... 좀 번거로운데, 이 작업을 할 때 쓸 수 있는 툴이 있을까요. 아니면 다른 방법이?

chytonpide · Answer

해본건 아니지만 컴파일러나 인터프리터에서 커스텀 정적검사 패스를 추가하면 되지 않을까요? (이런 옵션을 제공하는 컴파일러도 있었던 것 같은데..)아무튼 소스코드는 파싱되서 메모리상에 트리같은 자료구조 상태로 저장될때 주석같은게 전부 날아가니,커스텀 정적검사를 통해서 이 자료구조로 어떤 파일 출력물을 만들고, 이전에 만들어놓은 good 버전의 파일과 비교하는걸로 달성할 수 있지 않을까 하는 아이디어 입니다.

우르슬라 · Answer

예전에 LLVM 사용해서 코드 중간파일 IR 컨트롤 하는 컴파일러 만든 기억이 있는데, 이런거 이용해서 그냥 diff 때리는 스크립트 정도로 CI/CD 상에 테스트 스텝이 넣는건 어떤가요?

chytonpide · Answer

언어따라 다르지만 아래와 같은 느낌이 될것 같습니다.import com.github.javaparser.JavaParser; import com.github.javaparser.ParseResult; import com.github.javaparser.ParserConfiguration; import com.github.javaparser.ast.CompilationUnit; import java.io.File; import java.io.FileWriter; import java.io.IOException; import java.io.PrintWriter; public class JavaAstNodeTypePrinter { public static void printAstNodeTypes(String sourceCode, String outputPath) throws IOException { // 주석을 무시하는 설정 ParserConfiguration config = new ParserConfiguration(); config.setAttributeComments(false); JavaParser parser = new JavaParser(config); // 소스코드 파싱 ParseResult<CompilationUnit> parseResult = parser.parse(sourceCode); if (parseResult.isSuccessful() && parseResult.getResult().isPresent()) { CompilationUnit cu = parseResult.getResult().get(); File outputFile = new File(outputPath); try (PrintWriter writer = new PrintWriter(new FileWriter(outputFile))) { cu.walk(node -> { // 생성된 AST노드 클래스명(= 타입) 출력 writer.println(node.getClass().getSimpleName()); }); System.out.println("결과를 파일에 저장했습니다: " + outputFile.getAbsolutePath()); } catch (IOException e) { e.printStackTrace(); } } else { System.out.println("파싱에 실패했거나, 결과가 없습니다."); } } }테스트 예제import static org.junit.jupiter.api.Assertions.assertEquals; import java.io.IOException; import java.nio.file.Files; import java.nio.file.Path; import org.junit.jupiter.api.Test; public class JavaAstNodeTypePrinterTest { @Test public void printAstNodeTypes() throws IOException { // given // 주석을 포함한 예시 소스 String source1 = "public class MyClass {
" + " // 라인 주석
" + " private int value;
" + " /* 블록 주석 */
" + " public void print() {
" + " System.out.println(value);
" + " }
" + "}"; // 주석이 없는 예시 소스 String source2 = "public class MyClass {
" + " private int value;
" + " public void print() {
" + " System.out.println(value);
" + " }
" + "}"; String outputFileName1 = "ast_output1.txt"; String outputFileName2 = "ast_output2.txt"; // when JavaAstNodeTypePrinter.printAstNodeTypes(source1, outputFileName1); JavaAstNodeTypePrinter.printAstNodeTypes(source2, outputFileName2); // then String sourceAnalysisResult1 = Files.readString(Path.of(outputFileName1)); String sourceAnalysisResult2 = Files.readString(Path.of(outputFileName2)); assertEquals(sourceAnalysisResult1, sourceAnalysisResult2); } @Test public void verifyProgramSemanticsNotChanged() throws IOException { // 주석을 변경하기 전에 작성해 놓은 정적 분석 결과 String goodFileName = "good_ast_output.txt"; // 주석을 변경한 후의 정적 분석 결과 String newFileName = "ast_output.txt"; String goodContent = Files.readString(Path.of(goodFileName)); String newContent = Files.readString(Path.of(newFileName)); assertEquals(goodContent, newContent); } }예제에서는 단순하게 노드의 이름만 저장했습니다. 정적 분석결과 각 표현식과 문장의 타입 이름이 생성된거죠.실제로는 각 노드 타입별로 서로 다른 프로퍼티를 가지고 있고, 소스코드가 변경되었는지 확인하려면 프러퍼티의 값을 전부 분석결과로 만든다음 비교해야 합니다.AI 한테 해줘라고 하거나, (언어따라 다르겠지만 Expr(표현식) 및 Stmt(문장) 수는 대충 정해져있어서 직접 할만 할 것 같습니다.), 기존 정적 분석툴을 확장하시거나 활용하시면 좋을 것 같습니다. https://github.com/analysis-tools-dev/static-analysis기존 정적 분석툴들을 사용하시면 CI 에 통합시키기도 훨씬 수월할 것 같습니다.CI 상에서는 verifyProgramSemanticsNotChanged()에 보인것 처럼 처럼 단순하게 스트링 비교로 검증이 가능할 것 같습니다. (주석은 사이드 이팩트가 없고, 컴파일타임에만 살아숨쉬니, 정적 분석결과 같 같다면 프로그램의 의미도 같다고 볼 수 있습니다.)

코드에 주석만 변경했을 때 실제 코드 변경이 없는지 확인하는 법

3개의 답변

Q&A 목록