Issue 98: CLDK now supports getting crud operations from Java JPA applications

[rahlk]

Motivation and Context

We want to surface the database crud operations that are now produced by codeanalyzer version 2.2.0-dev (see issue #100)

How Has This Been Tested?

We have 5 new test cases in test_jcodeanalyzer.py that runs on plantsbywebsphere (made available in tests/resources/java/application/plantsbywebsphere.zip)

def test_get_all_get_crud_operations(test_fixture_pbw, codeanalyzer_jar_path):
    """It should return all of the CRUD operations in an application"""
    code_analyzer = JCodeanalyzer(
        project_dir=test_fixture_pbw,
        source_code=None,
        analysis_backend_path=codeanalyzer_jar_path,
        analysis_json_path=test_fixture_pbw / "build",
        analysis_level=AnalysisLevel.symbol_table,
        use_graalvm_binary=False,
        eager_analysis=True,
        target_files=None,
    )
    crud_operations = code_analyzer.get_all_crud_operations()
    assert crud_operations is not None
    for operation in crud_operations:
        assert operation is not None
        assert isinstance(operation, Dict)
        assert isinstance(operation["crud_operations"], list)
        for crud_op in operation["crud_operations"]:
            assert crud_op is not None
            assert isinstance(crud_op, JCRUDOperation)
            assert crud_op.line_number > 0
            assert crud_op.operation_type.value in ["CREATE", "READ", "UPDATE", "DELETE"]


def test_get_all_get_crud_read_operations(test_fixture_pbw, codeanalyzer_jar_path):
    """It should return all of the CRUD read operations in an application"""
    code_analyzer = JCodeanalyzer(
        project_dir=test_fixture_pbw,
        source_code=None,
        analysis_backend_path=codeanalyzer_jar_path,
        analysis_json_path=test_fixture_pbw / "build",
        analysis_level=AnalysisLevel.symbol_table,
        use_graalvm_binary=False,
        eager_analysis=True,
        target_files=None,
    )
    crud_operations = code_analyzer.get_all_read_operations()
    assert crud_operations is not None
    for operation in crud_operations:
        assert operation is not None
        assert isinstance(operation, Dict)
        assert isinstance(operation["crud_operations"], list)
        for crud_op in operation["crud_operations"]:
            assert crud_op is not None
            assert isinstance(crud_op, JCRUDOperation)
            assert crud_op.line_number > 0
            assert crud_op.operation_type.value == "READ"


def test_get_all_get_crud_create_operations(test_fixture_pbw, codeanalyzer_jar_path):
    """It should return all of the CRUD create operations in an application"""
    code_analyzer = JCodeanalyzer(
        project_dir=test_fixture_pbw,
        source_code=None,
        analysis_backend_path=codeanalyzer_jar_path,
        analysis_json_path=test_fixture_pbw / "build",
        analysis_level=AnalysisLevel.symbol_table,
        use_graalvm_binary=False,
        eager_analysis=True,
        target_files=None,
    )
    crud_operations = code_analyzer.get_all_create_operations()
    assert crud_operations is not None
    for operation in crud_operations:
        assert operation is not None
        assert isinstance(operation, Dict)
        assert isinstance(operation["crud_operations"], list)
        for crud_op in operation["crud_operations"]:
            assert crud_op is not None
            assert isinstance(crud_op, JCRUDOperation)
            assert crud_op.line_number > 0
            assert crud_op.operation_type.value == "CREATE"


def test_get_all_get_crud_update_operations(test_fixture_pbw, codeanalyzer_jar_path):
    """It should return all of the CRUD update operations in an application"""
    code_analyzer = JCodeanalyzer(
        project_dir=test_fixture_pbw,
        source_code=None,
        analysis_backend_path=codeanalyzer_jar_path,
        analysis_json_path=test_fixture_pbw / "build",
        analysis_level=AnalysisLevel.symbol_table,
        use_graalvm_binary=False,
        eager_analysis=True,
        target_files=None,
    )
    crud_operations = code_analyzer.get_all_update_operations()
    assert crud_operations is not None
    for operation in crud_operations:
        assert operation is not None
        assert isinstance(operation, Dict)
        assert isinstance(operation["crud_operations"], list)
        for crud_op in operation["crud_operations"]:
            assert crud_op is not None
            assert isinstance(crud_op, JCRUDOperation)
            assert crud_op.line_number > 0
            assert crud_op.operation_type.value == "UPDATE"


def test_get_all_get_crud_delete_operations(test_fixture_pbw, codeanalyzer_jar_path):
    """It should return all of the CRUD delete operations in an application"""
    code_analyzer = JCodeanalyzer(
        project_dir=test_fixture_pbw,
        source_code=None,
        analysis_backend_path=codeanalyzer_jar_path,
        analysis_json_path=test_fixture_pbw / "build",
        analysis_level=AnalysisLevel.symbol_table,
        use_graalvm_binary=False,
        eager_analysis=True,
        target_files=None,
    )
    crud_operations = code_analyzer.get_all_delete_operations()
    assert crud_operations is not None
    for operation in crud_operations:
        assert operation is not None
        assert isinstance(operation, Dict)
        assert isinstance(operation["crud_operations"], list)
        for crud_op in operation["crud_operations"]:
            assert crud_op is not None
            assert isinstance(crud_op, JCRUDOperation)
            assert crud_op.line_number > 0
            assert crud_op.operation_type.value == "DELETE"

Breaking Changes

No. Should be backwards compatible.

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)
• Documentation update

Checklist

• I have read the Codellm-Devkit Documentation
• My code follows the repository's style guidelines
• New and existing tests pass locally
• I have added appropriate error handling
• I have added or updated documentation as needed

Additional context

• See issue #98 for more context.
• Also see codeanalyzer-java's issue #100