Project Phase III + Final Report

Due December 11, 2024, 11:59 AM

• Using GitHub:
  1. Go to your GitHub repository
  2. Click on the "pull requests" tab
  3. Find the requests for phase 3 starter code
  4. Resolve the confilicts in the web editor. Please retain the code you implemented in the previous phases along with the newly provided starter code for Phase 3.
  5. Click on the "merge pull request" button

• ast_path_set.py: You need to address the TODOs in this file.
  An AstPathSet maintains a list of paths of a method, along with the method's name.
  • You need to implement is_empty method, which returns true if the path list is empty
  • You need to implement add_path method. This method should construct a new AstPath object using the provided source node, target node, and path string, then add it to the path list.
• In common.py
  • MethodContents: You don't need to modify this class definition.
  The leaf nodes, method name, and method length (line of codes without comments and empty lines) is collected and stored to a MethodContents when visiting a method node.
• function_visitor.py: You need to address the TODOs in this file.
  FunctionVisitor traverses a Java program to visit each method and collect its contents for storage in a MethodContents object.
  • You need to implement the visit method. Ensure that the visitMethod is invoked whenever a node with the method_declaration type is encountered. This will process the method node and collect the relevant data.
• In path_extractor.py
  • extract_single_method_paths(self, method: MethodContents) -> AstPathSet: You need to address the TODOs in this method.
    It extracts all the paths of a method given the MethodContents of that method.
    • You need to implement the extraction of all paths of a method by using extract_path method you implemented in Phase 2. Append the extracted paths to the list and return the list.
  • extract_methods_paths(self, methods: List[MethodContents]) -> List[AstPathSet]: You need to address the TODOs in this method. It extracts all the paths given a list of MethodContents.
    • You need to skip the extraction of a method if the method length is less than MinCodeLen or greater than MaxCodeLen.
    • You need to append the extracted paths to the methods_paths list.
  • __parse_file(self, code): You don't need to modify this method. It returns the root node of the AST parsed from the given code snippet.
  • extract_paths(self, code: str) -> List[AstPathSet]: You don't need to modify this method. It extract all paths of all methods in the given code snippet.
• In tests/test_phase3.py
  • test_function_visitor(): It tests the functionality of the FunctionVisitor you implemented.
  • test_single_method_extraction(): It tests the functionality of the extract_single_method_paths you implemented.
  • test_all_methods_all_paths_extraction(): It tests the functionality of the extract_methods_paths you implemented.

1. Change directory to your project root directory.

2. pytest tests/test_phase3.py

• The coding part of phase 3 will account for 10% of your final grade. We will have additional private test cases in the autograder. You grade will be determined based on the percentage of test cases your submission passes.
• Final report will account for 5% of your final grade. Please submit your project final report via Canvas. More details in Project Report Guidelines.