diff --git a/.github/workflows/report-connectors-dependency.yml b/.github/workflows/report-connectors-dependency.yml new file mode 100644 index 000000000000..8e60d2c94b49 --- /dev/null +++ b/.github/workflows/report-connectors-dependency.yml @@ -0,0 +1,42 @@ +name: Report connectors dependency + +on: + pull_request: + +jobs: + report-affected-connectors: + name: "Report affected connectors" + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + with: + fetch-depth: 0 # OR "2" -> To retrieve the preceding commit. + + - name: Extract current branch name + shell: bash + run: echo "##[set-output name=branch;]$(echo ${{ github.head_ref }})" + id: extract_branch + - name: Extract git-dif change file + run: | + git diff --name-only remotes/origin/master...origin/${{ steps.extract_branch.outputs.branch }} -- airbyte-integrations/ > ./changed_files.txt + id: extract_changed_files + - name: Install dependencies + run: | + python -m pip install --upgrade pip + - name: Create dependency report + run: | + output=$(python ./tools/bin/ci_check_dependency.py ./changed_files.txt) + output="${output//'%'/'%25'}" + output="${output//$'\n'/'%0A'}" + output="${output//$'\r'/'%0D'}" + echo "::set-output name=changed_files_report::$output" + id: dependency_report + - name: Comment report in PR + if: steps.dependency_report.outputs.changed_files_report != '' + uses: peter-evans/create-or-update-comment@v2 + with: + issue-number: ${{ github.event.pull_request.number }} + body: | + **NOTE** :warning: Changes in this PR affect the following connectors. Make sure to run corresponding integration tests: + ${{steps.dependency_report.outputs.changed_files_report}} + diff --git a/tools/bin/ci_check_dependency.py b/tools/bin/ci_check_dependency.py new file mode 100644 index 000000000000..df983e65c311 --- /dev/null +++ b/tools/bin/ci_check_dependency.py @@ -0,0 +1,92 @@ +import sys +import os +import os.path + +CONNECTOR_FOLDER = "airbyte-integrations/connectors/" +CONNECTOR_PATH = "./airbyte-integrations/connectors/" +IGNORE_LIST = [ + # Java + "/src/test/","/src/test-integration/", "/src/testFixtures/", + # Python + "/integration_tests/", "/unit_tests/", + # Common + "acceptance-test-config.yml", "acceptance-test-docker.sh", ".md", ".dockerignore", ".gitignore", "requirements.txt"] + + +def main(): + # Used git diff checks airbyte-integrations/ folder only + # See .github/workflows/report-connectors-dependency.yml file + git_diff_file_path = ' '.join(sys.argv[1:]) + + # Get changed files + changed_files = get_changed_files(git_diff_file_path) + # Get changed modules. e.g. source-acceptance-test from airbyte-integrations/bases/ + # or destination-mysql from airbyte-integrations/connectors/ + changed_modules = get_changed_modules(changed_files) + + # Get all existing connectors + all_connectors = get_all_connectors() + + # Getting all build.gradle file + all_build_gradle_files = get_connectors_gradle_files(all_connectors) + + # Try to find dependency in build.gradle file + depended_connectors = list(set(get_depended_connectors(changed_modules, all_build_gradle_files))) + write_report(depended_connectors) + + +def get_changed_files(path): + changed_connectors_files = [] + with open(path) as file: + for line in file: + changed_connectors_files.append(line) + return changed_connectors_files + + +def get_changed_modules(changed_files): + changed_modules = [] + for changed_file in changed_files: + # Check if this file should be ignored + if not any(ignor in changed_file for ignor in IGNORE_LIST): + split_changed_file = changed_file.split("/") + changed_modules.append(split_changed_file[1] + ":" + split_changed_file[2]) + return list(set(changed_modules)) + + +def get_all_connectors(): + walk = os.walk(CONNECTOR_PATH) + return [connector for connector in next(walk)[1]] + + +def get_connectors_gradle_files(all_connectors): + all_build_gradle_files = {} + for connector in all_connectors: + build_gradle_path = CONNECTOR_PATH + connector + "/" + build_gradle_file = find_file("build.gradle", build_gradle_path) + all_build_gradle_files[connector] = build_gradle_file + return all_build_gradle_files + + +def find_file(name, path): + for root, dirs, files in os.walk(path): + if name in files: + return os.path.join(root, name) + + +def get_depended_connectors(changed_connectors, all_build_gradle_files): + depended_connectors = [] + for changed_connector in changed_connectors: + for connector, gradle_file in all_build_gradle_files.items(): + with open(gradle_file) as file: + if changed_connector in file.read(): + depended_connectors.append(connector) + return depended_connectors + + +def write_report(depended_connectors): + for depended_connector in depended_connectors: + print("- " + depended_connector) + + +if __name__ == "__main__": + main()