OpenMetadata/ingestion/tests/cli_e2e/README.md

E2E CLI tests

Currently, it runs CLI tests for any database connector.

• test_cli_db_base has 8 test definitions for database connectors. It is an abstract class.
• test_cli_db_base_common is another abstract class which for those connectors whose sources implement the CommonDbSourceService class.
• It partially implements some methods from test_cli_db_base.
• test_cli_{connector} is the specific connector test. More tests apart the ones implemented by the test_cli_db_base can be run inside this class.

How to add a database connector

1. Use test_cli_mysql.py as example. Your connector E2E CLI test must follow the name convention: test_cli_{connector}.py and the test class must extend from CliCommonDB.TestSuite if the connector's source implement the CommonDbSourceService class, otherwise, from CliDBBase.TestSuite.

2. Add an ingestion YAML file with the service and the credentials of it. Use when possible a Dockerized environment, otherwise, remember to use environment variables for sensitive information in case of external resources. On each test, the YAML file will be modified by the build_yaml method which will create a copy of the file and prepare it for the tests. This way, we avoid adding (and maintaining) an extra YAML for each test.

3. The {connector} name must be added in the list of connectors in the GH Action: .github/workflows/py-cli-e2e-tests.yml

jobs:
  py-cli-e2e-tests:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        py-version: ['3.9']
        e2e-test: ['mysql', '{connector}']

4. If it is a database connector whose source implement the CommonDbSourceService class, these methods must be overwritten:

    # the connector name
    def get_connector_name() -> str:
        return "{connector}"

    # create using the SQLAlchemy engine a table, a view associated to it and add some rows to the table
    def create_table_and_view(self) -> None:
        pass
    
    # delete the view and table created using the SQLAlchemy engine
    def delete_table_and_view(self) -> None:
        pass
    
    # expected tables to be ingested
    def expected_tables() -> int:
        pass

    # numbers of rows added to the created table
    def inserted_rows_count(self) -> int:
        pass

    # created table FQN
    def fqn_created_table() -> str:
        pass

    # list of schemas patterns to be included in the schema filters
    def get_includes_schemas() -> List[str]:
        pass

    # list of table patterns to be included in the table filters
    def get_includes_tables() -> List[str]:
        pass

    # list of table patterns to be excluded in the table filters
    def get_excludes_tables() -> List[str]:
        pass
    
    # expected number of schemas to be filtered with the use of includes (get_includes_schemas)
    def expected_filtered_schema_includes() -> int:
        pass
    
    # expected number of schemas to be filtered with the use of excludes (get_includes_schemas)
    def expected_filtered_schema_excludes() -> int:
        pass

    # expected number of tables to be filtered with the use of includes (get_includes_tables)
    def expected_filtered_table_includes() -> int:
        pass

    # expected number of tables to be filtered with the use of excludes (get_includes_tables)
    def expected_filtered_table_excludes() -> int:
        pass

    # expected number of filter entities with the use of a mix of filters (get_includes_schemas, get_includes_tables, get_excludes_tables)
    def expected_filtered_mix() -> int:
        pass