From f29704e33462722a5d81695c6f93d9a2cdd2cded Mon Sep 17 00:00:00 2001 From: David DE CARVALHO Date: Sat, 5 Aug 2023 18:07:08 +0200 Subject: [PATCH] first commit to get all sources from 'ecoCode' repository --- .gitattributes | 7 + .github/ISSUE_TEMPLATE/bug_report.md | 33 + .github/ISSUE_TEMPLATE/feature_request.md | 20 + .github/workflows/build.yml | 45 ++ .github/workflows/manual_release.yml | 133 ++++ .github/workflows/stale_tag.yml | 21 + .github/workflows/tag_release.yml | 71 ++ .gitignore | 14 + CHANGELOG.md | 18 + CODE_STYLE.md | 1 + CONTRIBUTING.md | 1 + Dockerfile | 9 + INSTALL.md | 32 + LICENCE.md | 674 ++++++++++++++++++ README.md | 61 ++ RULES.md | 1 + TODOs_DDC.md | 19 + docker-compose.yml | 46 ++ pom.xml | 223 ++++++ .../python/PythonPlugin.java | 28 + .../python/PythonRuleRepository.java | 69 ++ .../python/checks/AvoidDoubleQuoteCheck.java | 24 + .../python/checks/AvoidFullSQLRequest.java | 68 ++ .../python/checks/AvoidGettersAndSetters.java | 74 ++ .../AvoidGlobalVariableInFunctionCheck.java | 320 +++++++++ .../AvoidListComprehensionInIterations.java | 71 ++ .../python/checks/AvoidSQLRequestInLoop.java | 84 +++ .../checks/AvoidTryCatchFinallyCheck.java | 27 + .../AvoidUnoptimizedVectorImagesCheck.java | 72 ++ .../checks/DetectUnoptimizedImageFormat.java | 35 + .../NoFunctionCallWhenDeclaringForLoop.java | 24 + .../python/package-info.java | 21 + .../python/PythonPluginTest.java | 42 ++ .../python/PythonRuleRepositoryTest.java | 103 +++ .../python/checks/AvoidDoubleQuoteTest.java | 11 + .../checks/AvoidFullSQLRequestTest.java | 12 + .../checks/AvoidGettersAndSettersTest.java | 12 + ...voidGlobalVariableInFunctionCheckTest.java | 11 + ...voidListComprehensionInIterationsTest.java | 11 + .../checks/AvoidSQLRequestInLoopTest.java | 12 + .../checks/AvoidTryCatchFinallyCheckTest.java | 12 + .../AvoidUnoptimizedVectorImagesTest.java | 12 + .../DetectUnoptimizedImageFormatTest.java | 13 + ...oFunctionCallWhenDeclaringForLoopTest.java | 11 + .../AvoidListComprehensionInIterations.py | 35 + .../resources/checks/avoidDoubleQuoteCheck.py | 13 + .../resources/checks/avoidFullSQLRequest.py | 10 + .../checks/avoidGettersAndSetters.py | 26 + .../checks/avoidGlobalVariableInFunction.py | 43 ++ .../resources/checks/avoidSQLRequestInLoop.py | 42 ++ .../checks/avoidSQLRequestInLoopCheck.py | 83 +++ .../checks/avoidSQLRequestInLoopNoImports.py | 26 + .../checks/avoidTryCatchFinallyCheck.py | 29 + .../checks/avoidUnoptimizedVectorImages.py | 5 + .../checks/detectUnoptimizedImageFormat.py | 36 + .../detectUnoptimizedImageFormatCompliant.py | 17 + src/test/resources/checks/init_dbtest.sql | 34 + src/test/resources/checks/my.conf.sample | 5 + .../noFunctionCallWhenDeclaringForLoop.py | 9 + tool_build.sh | 4 + tool_compile.sh | 3 + tool_docker-clean.sh | 3 + tool_docker-init.sh | 3 + tool_docker-logs.sh | 3 + tool_release_1_prepare.sh | 13 + tool_release_2_branch.sh | 13 + tool_start.sh | 3 + tool_start_withtoken.sh | 4 + tool_stop.sh | 3 + 69 files changed, 3073 insertions(+) create mode 100644 .gitattributes create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/workflows/build.yml create mode 100644 .github/workflows/manual_release.yml create mode 100644 .github/workflows/stale_tag.yml create mode 100644 .github/workflows/tag_release.yml create mode 100644 .gitignore create mode 100644 CHANGELOG.md create mode 100644 CODE_STYLE.md create mode 100644 CONTRIBUTING.md create mode 100644 Dockerfile create mode 100644 INSTALL.md create mode 100644 LICENCE.md create mode 100644 README.md create mode 100644 RULES.md create mode 100644 TODOs_DDC.md create mode 100644 docker-compose.yml create mode 100644 pom.xml create mode 100644 src/main/java/fr/greencodeinitiative/python/PythonPlugin.java create mode 100644 src/main/java/fr/greencodeinitiative/python/PythonRuleRepository.java create mode 100644 src/main/java/fr/greencodeinitiative/python/checks/AvoidDoubleQuoteCheck.java create mode 100644 src/main/java/fr/greencodeinitiative/python/checks/AvoidFullSQLRequest.java create mode 100644 src/main/java/fr/greencodeinitiative/python/checks/AvoidGettersAndSetters.java create mode 100644 src/main/java/fr/greencodeinitiative/python/checks/AvoidGlobalVariableInFunctionCheck.java create mode 100644 src/main/java/fr/greencodeinitiative/python/checks/AvoidListComprehensionInIterations.java create mode 100644 src/main/java/fr/greencodeinitiative/python/checks/AvoidSQLRequestInLoop.java create mode 100644 src/main/java/fr/greencodeinitiative/python/checks/AvoidTryCatchFinallyCheck.java create mode 100644 src/main/java/fr/greencodeinitiative/python/checks/AvoidUnoptimizedVectorImagesCheck.java create mode 100644 src/main/java/fr/greencodeinitiative/python/checks/DetectUnoptimizedImageFormat.java create mode 100644 src/main/java/fr/greencodeinitiative/python/checks/NoFunctionCallWhenDeclaringForLoop.java create mode 100644 src/main/java/fr/greencodeinitiative/python/package-info.java create mode 100644 src/test/java/fr/greencodeinitiative/python/PythonPluginTest.java create mode 100644 src/test/java/fr/greencodeinitiative/python/PythonRuleRepositoryTest.java create mode 100644 src/test/java/fr/greencodeinitiative/python/checks/AvoidDoubleQuoteTest.java create mode 100644 src/test/java/fr/greencodeinitiative/python/checks/AvoidFullSQLRequestTest.java create mode 100644 src/test/java/fr/greencodeinitiative/python/checks/AvoidGettersAndSettersTest.java create mode 100644 src/test/java/fr/greencodeinitiative/python/checks/AvoidGlobalVariableInFunctionCheckTest.java create mode 100644 src/test/java/fr/greencodeinitiative/python/checks/AvoidListComprehensionInIterationsTest.java create mode 100644 src/test/java/fr/greencodeinitiative/python/checks/AvoidSQLRequestInLoopTest.java create mode 100644 src/test/java/fr/greencodeinitiative/python/checks/AvoidTryCatchFinallyCheckTest.java create mode 100644 src/test/java/fr/greencodeinitiative/python/checks/AvoidUnoptimizedVectorImagesTest.java create mode 100644 src/test/java/fr/greencodeinitiative/python/checks/DetectUnoptimizedImageFormatTest.java create mode 100644 src/test/java/fr/greencodeinitiative/python/checks/NoFunctionCallWhenDeclaringForLoopTest.java create mode 100644 src/test/resources/checks/AvoidListComprehensionInIterations.py create mode 100644 src/test/resources/checks/avoidDoubleQuoteCheck.py create mode 100644 src/test/resources/checks/avoidFullSQLRequest.py create mode 100644 src/test/resources/checks/avoidGettersAndSetters.py create mode 100644 src/test/resources/checks/avoidGlobalVariableInFunction.py create mode 100644 src/test/resources/checks/avoidSQLRequestInLoop.py create mode 100644 src/test/resources/checks/avoidSQLRequestInLoopCheck.py create mode 100644 src/test/resources/checks/avoidSQLRequestInLoopNoImports.py create mode 100644 src/test/resources/checks/avoidTryCatchFinallyCheck.py create mode 100644 src/test/resources/checks/avoidUnoptimizedVectorImages.py create mode 100644 src/test/resources/checks/detectUnoptimizedImageFormat.py create mode 100644 src/test/resources/checks/detectUnoptimizedImageFormatCompliant.py create mode 100644 src/test/resources/checks/init_dbtest.sql create mode 100644 src/test/resources/checks/my.conf.sample create mode 100644 src/test/resources/checks/noFunctionCallWhenDeclaringForLoop.py create mode 100755 tool_build.sh create mode 100755 tool_compile.sh create mode 100755 tool_docker-clean.sh create mode 100755 tool_docker-init.sh create mode 100755 tool_docker-logs.sh create mode 100755 tool_release_1_prepare.sh create mode 100755 tool_release_2_branch.sh create mode 100755 tool_start.sh create mode 100755 tool_start_withtoken.sh create mode 100755 tool_stop.sh diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..12b960c --- /dev/null +++ b/.gitattributes @@ -0,0 +1,7 @@ +# Ensure all SH files are checked out with LF line endings (regardless of the +# OS they were checked out on). +*.sh text eol=lf + +# Ensure BAT files will always be checked out with CRLFs (regardless of the +# OS they were checked out on). +*.bat text eol=crlf \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..da62cca --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,33 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: bug +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: + +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Software Versions** + +- SonarQube Version: [e.g. Version 7.8 (build 26217)] +- Plugin Version: [e.g. 1.1.0, or custom build from master at commit 004AD34FAA] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..bbcbbe7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: '' +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml new file mode 100644 index 0000000..04eb758 --- /dev/null +++ b/.github/workflows/build.yml @@ -0,0 +1,45 @@ +name: Build and Tests +on: + push: + branches: + - main + paths-ignore: + - '*.md' + - '.github/**/*.yml' + tags: + - '[0-9]+.[0-9]+.[0-9]+' + pull_request: + types: [opened, synchronize, reopened] +jobs: + build: + name: Build + runs-on: ubuntu-latest + permissions: + pull-requests: read # allows SonarCloud to decorate PRs with analysis results + steps: + - name: Checkout + uses: actions/checkout@v3 + with: + fetch-depth: 0 # Shallow clones should be disabled for a better relevancy of analysis + - name: Set up JDK 11 + uses: actions/setup-java@v3 + with: + java-version: 11 + distribution: 'zulu' # Alternative distribution options are available. + - name: Cache SonarCloud packages + uses: actions/cache@v3 + with: + path: ~/.sonar/cache + key: ${{ runner.os }}-sonar + restore-keys: ${{ runner.os }}-sonar + - name: Cache Maven packages + uses: actions/cache@v3 + with: + path: ~/.m2 + key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }} + restore-keys: ${{ runner.os }}-m2 + - name: Build and analyze + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }} + run: mvn -e -B verify org.sonarsource.scanner.maven:sonar-maven-plugin:sonar -Dsonar.projectKey=green-code-initiative_ecoCode-python -Dsonar.exclusions=**/*.groovy,**/*.dummy diff --git a/.github/workflows/manual_release.yml b/.github/workflows/manual_release.yml new file mode 100644 index 0000000..e3d2257 --- /dev/null +++ b/.github/workflows/manual_release.yml @@ -0,0 +1,133 @@ +name: Manual Release +on: + workflow_dispatch: + inputs: + confirmeRelease: + description: 'Confirm manual release creation (by typing "true") ? ----- WARNING : check version (in pom.xml files) and release notes (in CHANGELOG.md file) before confirm' + default: 'false' +jobs: + checks: + name: Requirements + if: github.event.inputs.confirmeRelease == 'true' + runs-on: ubuntu-latest + steps: + - name: Check user permissions + uses: 74th/workflow-permission-action@1.0.0 + with: + users: dedece35,glalloue,jhertout,jules-delecour-dav,olegoaer,zippy1978 + build: + name: Build And Release + needs: checks + runs-on: ubuntu-latest + permissions: write-all + outputs: + last_tag: ${{ steps.export_last_tag.outputs.last_tag }} + upload_url: ${{ steps.export_upload_url.outputs.upload_url }} + steps: + - name: Checkout + uses: actions/checkout@v3 + - name: Change commiter + run: | + git config user.name 'github-actions[bot]' + git config user.email '' + - name: Maven release + run: mvn release:prepare -B -ff -DtagNameFormat=@{project.version} + - name: Maven release clean + run: mvn release:clean + - name: Get last TAG + run: echo "LAST_TAG=$(git tag --sort=-version:refname | head -n 1)" >> $GITHUB_ENV + - name: Extract release notes + id: extract-release-notes + uses: ffurrer2/extract-release-notes@v1 + - name: Checkout tag "${{ env.LAST_TAG }}" + uses: actions/checkout@v3 + with: + ref: ${{ env.LAST_TAG }} + - name: Build project + run: mvn -e -B clean package -DskipTests + - name: Create release + id: create_release + uses: actions/create-release@v1 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + with: + tag_name: ${{ env.LAST_TAG }} + release_name: Release ${{ env.LAST_TAG }} + draft: false + prerelease: false + body: ${{ steps.extract-release-notes.outputs.release_notes }} + - name: Export plugin Jar files + id: export_jar_files + uses: actions/upload-artifact@v3 + with: + name: ecocode-plugins + path: lib + - name: Export LAST_TAG + id: export_last_tag + run: echo "last_tag=${{ env.LAST_TAG }}" >> $GITHUB_OUTPUT + - name: Export UPLOAD_URL + id: export_upload_url + run: echo "upload_url=${{ steps.create_release.outputs.upload_url }}" >> $GITHUB_OUTPUT + upload-java: + name: Upload Java Plugin + runs-on: ubuntu-latest + needs: build + steps: + - name: Import plugin JAR files + id: import_jar_files + uses: actions/download-artifact@v3 + with: + name: ecocode-plugins + path: lib + - name: Upload Release Asset - Java Plugin + id: upload-release-asset + uses: actions/upload-release-asset@v1 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + with: + upload_url: ${{needs.build.outputs.upload_url}} + asset_path: lib/ecocode-java-plugin-${{ needs.build.outputs.last_tag }}.jar + asset_name: ecocode-java-plugin-${{ needs.build.outputs.last_tag }}.jar + asset_content_type: application/zip + upload-php: + name: Upload PHP Plugin + runs-on: ubuntu-latest + needs: build + steps: + - name: Import plugin JAR files + id: import_jar_files + uses: actions/download-artifact@v3 + with: + name: ecocode-plugins + path: lib + - name: Upload Release Asset - PHP Plugin + id: upload-release-asset + uses: actions/upload-release-asset@v1 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + with: + upload_url: ${{needs.build.outputs.upload_url}} + asset_path: lib/ecocode-php-plugin-${{ needs.build.outputs.last_tag }}.jar + asset_name: ecocode-php-plugin-${{ needs.build.outputs.last_tag }}.jar + asset_content_type: application/zip + upload-python: + name: Upload Python Plugin + runs-on: ubuntu-latest + needs: build + steps: + - name: Import plugin JAR files + id: import_jar_files + uses: actions/download-artifact@v3 + with: + name: ecocode-plugins + path: lib + - name: Upload Release Asset - Python Plugin + id: upload-release-asset + uses: actions/upload-release-asset@v1 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + with: + upload_url: ${{needs.build.outputs.upload_url}} + asset_path: lib/ecocode-python-plugin-${{ needs.build.outputs.last_tag }}.jar + asset_name: ecocode-python-plugin-${{ needs.build.outputs.last_tag }}.jar + asset_content_type: application/zip diff --git a/.github/workflows/stale_tag.yml b/.github/workflows/stale_tag.yml new file mode 100644 index 0000000..4c7a9ff --- /dev/null +++ b/.github/workflows/stale_tag.yml @@ -0,0 +1,21 @@ +name: "Label stale PRs" +on: + schedule: + - cron: "30 1 * * *" + workflow_dispatch: + +jobs: + stale: + runs-on: ubuntu-latest + steps: + - uses: actions/stale@v8.0.0 + with: + repo-token: ${{ secrets.GITHUB_TOKEN }} + days-before-issue-stale: -1 # We don't want to address issues + days-before-pr-stale: 30 + days-before-issue-close: -1 # We don't want to close issues in this action + days-before-pr-close: -1 # We don't want to close PR in this action + stale-pr-label: stale + stale-pr-message: | + This PR has been automatically marked as stale because it has no activity for 30 days. + Please add a comment if you want to keep the issue open. Thank you for your contributions! \ No newline at end of file diff --git a/.github/workflows/tag_release.yml b/.github/workflows/tag_release.yml new file mode 100644 index 0000000..e63b337 --- /dev/null +++ b/.github/workflows/tag_release.yml @@ -0,0 +1,71 @@ +name: Tag Release +on: + push: + tags: + - '[0-9]+.[0-9]+.[0-9]+' +jobs: + checks: + name: Requirements + runs-on: ubuntu-latest + steps: + - name: Check user permissions + uses: 74th/workflow-permission-action@1.0.0 + with: + users: dedece35,glalloue,jhertout,jules-delecour-dav,olegoaer,zippy1978 + build: + name: Build And Release + runs-on: ubuntu-latest + needs: checks + outputs: + upload_url: ${{ steps.create_release.outputs.upload_url }} + steps: + - name: Checkout tag "${{ github.ref_name }}" + uses: actions/checkout@v3 + with: + ref: ${{ github.ref_name }} + - name: Extract release notes + id: extract-release-notes + uses: ffurrer2/extract-release-notes@v1 + - name: Build project + run: mvn -e -B clean package -DskipTests + - name: Create release + id: create_release + uses: actions/create-release@v1 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + with: + tag_name: ${{ github.ref_name }} + release_name: Release ${{ github.ref_name }} + draft: false + prerelease: false + body: ${{ steps.extract-release-notes.outputs.release_notes }} + - name: Export plugin Jar files + id: export_jar_files + uses: actions/upload-artifact@v3 + with: + name: ecocode-plugins + path: lib + - name: Export UPLOAD_URL + id: export_upload_url + run: echo "upload_url=${{ steps.create_release.outputs.upload_url }}" >> $GITHUB_OUTPUT + upload-python: + name: Upload Python Plugin + runs-on: ubuntu-latest + needs: build + steps: + - name: Import plugin JAR files + id: import_jar_files + uses: actions/download-artifact@v3 + with: + name: ecocode-plugins + path: lib + - name: Upload Release Asset - Python Plugin + id: upload-release-asset + uses: actions/upload-release-asset@v1 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + with: + upload_url: ${{needs.build.outputs.upload_url}} + asset_path: lib/ecocode-python-plugin-${{ github.ref_name }}.jar + asset_name: ecocode-python-plugin-${{ github.ref_name }}.jar + asset_content_type: application/zip diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..617bbe0 --- /dev/null +++ b/.gitignore @@ -0,0 +1,14 @@ +# Ignore all files and folders starting with ".", except a few exceptions +.* +!.gitignore +!.gitattributes +!.github/ + +# Ignore generated files +target +lib +bin +dependency-reduced-pom.xml + +# Ignore IDE files +*.iml diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..2967bd9 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,18 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased] + +### Added + +- Python rules moved from `ecoCode` repository to current repository + +### Changed + +### Deleted + +[unreleased]: https://github.com/green-code-initiative/ecoCode-python/compare/v0.0.1...HEAD diff --git a/CODE_STYLE.md b/CODE_STYLE.md new file mode 100644 index 0000000..86b0ab3 --- /dev/null +++ b/CODE_STYLE.md @@ -0,0 +1 @@ +Please read common [CODE_STYLE.md](https://github.com/green-code-initiative/ecoCode-common/blob/main/doc/CODE_STYLE.md) in `ecoCode-common` repository. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..77e81dc --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1 @@ +Please read common [CONTRIBUTING.md](https://github.com/green-code-initiative/ecoCode-common/blob/main/doc/CONTRIBUTING.md) in `ecoCode-common` repository. diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..bd5462f --- /dev/null +++ b/Dockerfile @@ -0,0 +1,9 @@ +FROM maven:3-openjdk-11-slim AS builder + +COPY . /usr/src/ecocode + +WORKDIR /usr/src/ecocode +RUN ./tool_build.sh + +FROM sonarqube:10.0.0-community +COPY --from=builder /usr/src/ecocode/lib/* /opt/sonarqube/extensions/plugins/ diff --git a/INSTALL.md b/INSTALL.md new file mode 100644 index 0000000..71942a0 --- /dev/null +++ b/INSTALL.md @@ -0,0 +1,32 @@ +- [Project structure](#project-structure) +- [Plugin-specific guides](#plugin-specific-guides) + +Common installation notes / requirements +======================================== + +Please read common [INSTALL.md](https://github.com/green-code-initiative/ecoCode-common/blob/main/doc/INSTALL.md) +in `ecoCode-common` repository. Please follow the specific guides below for additional information on installing the +desired plugins. + +Special points for Standard plugins +================================= + +Project structure +----------------- + +Here is a preview of project tree : + +```txt +ecoCode-php # Root directory +| ++--src # source directory +| +\--docker-compose.yml # Docker compose file +``` + +You will find more information about the plugins’ architecture in their folders + +Plugin-specific guides +---------------------- + +- [PHP how-to](php-plugin/README.md) diff --git a/LICENCE.md b/LICENCE.md new file mode 100644 index 0000000..20d40b6 --- /dev/null +++ b/LICENCE.md @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..156896d --- /dev/null +++ b/README.md @@ -0,0 +1,61 @@ +EcoCode-php +=========== + +_ecoCode_ is a collective project aiming to reduce environmental footprint of software at the code level. The goal of +the project is to provide a list of static code analyzers to highlight code structures that may have a negative +ecological impact: energy and resources over-consumption, "fatware", shortening terminals' lifespan, etc. + +_ecoCode_ is based on evolving catalogs of [good practices](docs/rules), for various technologies. A SonarQube plugin +then implements these catalogs as rules for scanning your projects. + +**Warning**: this is still a very early stage project. Any feedback or contribution will be highly appreciated. Please +refer to the contribution section. + +[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) +[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](https://github.com/green-code-initiative/ecoCode-common/blob/main/doc/CODE_OF_CONDUCT.md) + +🌿 SonarQube Plugins +------------------- + +check [ecoCode repository](https://github.com/green-code-initiative/ecoCode) + +🚀 Getting Started +------------------ + +check [ecoCode repository](https://github.com/green-code-initiative/ecoCode) + +🛒 Distribution +------------------ + +Ready to use binaries are available [from GitHub](https://github.com/green-code-initiative/ecoCode-php/releases). + +🧩 Plugins version compatibility +------------------ + +| Plugins Version | SonarQube version | +|------------------|-----------------------------| +| <= 1.3.+ | check `ecoCode` repository | +| 1.4.+ | SonarQube 9.4.+ LTS to 10.0 | + +☕ Plugin Java part compatibility +------------------ + +| Plugins Version | Java version | +|------------------|-----------------------------| +| <= 1.3.+ | check `ecoCode` repository | +| 1.4.+ | 11 / 17 | + +🤝 Contribution +--------------- + +check [ecoCode repository](https://github.com/green-code-initiative/ecoCode) + +🤓 Main contributors +-------------------- + +check [ecoCode repository](https://github.com/green-code-initiative/ecoCode) + +Links +----- + +- https://docs.sonarqube.org/latest/analysis/overview/ diff --git a/RULES.md b/RULES.md new file mode 100644 index 0000000..13bf375 --- /dev/null +++ b/RULES.md @@ -0,0 +1 @@ +Please read [RULES.md](https://github.com/green-code-initiative/ecoCode/blob/main/RULES.md) in `ecoCode` repository. diff --git a/TODOs_DDC.md b/TODOs_DDC.md new file mode 100644 index 0000000..1cec0de --- /dev/null +++ b/TODOs_DDC.md @@ -0,0 +1,19 @@ +TODOS dev DDC +=== + +actions vues en séance weekly-meeting : + +- ecoCode-android : nettoyer packages (suite au release) +- teams : nettoyer anciennes équipes + +actions vues perso : + +- nettoyer le MIGRATION_TODOs.md +- ménage dans les branches de dev (local et remote) +- JYC : suppression dépendance analyser-commons ==> check si bien tout nettoyé (version dans pom, référence dans code) +- créer issue sur la rule EC2 (`avoidMultipleIfElse`) sur JAVA : + - à refondre avec les uses cases du PHP + implem du PHP (en cours - PR_160_recup) + - JAVA : existe depuis longtemps !!! normal que l'implem PHP et python aient le même code minimaliste fonctionellement +- voir les rules désativées chez PJ, créer des issues et corriger (`avoidMultipleIfElse`) : + - voir pourquoi désactivées car ralaient trop + - retester le EC2 \ No newline at end of file diff --git a/docker-compose.yml b/docker-compose.yml new file mode 100644 index 0000000..9e0ab9c --- /dev/null +++ b/docker-compose.yml @@ -0,0 +1,46 @@ +version: "3.3" +services: + sonar: + image: sonarqube:10.0.0-community + container_name: sonar_ecocode_python + ports: + - "9000:9000" + networks: + - sonarnet + depends_on: + - db + environment: + SONAR_JDBC_USERNAME: sonar + SONAR_JDBC_PASSWORD: sonar + SONAR_JDBC_URL: jdbc:postgresql://db:5432/sonarqube + SONAR_ES_BOOTSTRAP_CHECKS_DISABLE: 'true' + volumes: + - type: bind + source: ./target/ecocode-python-plugin-1.4.0-SNAPSHOT.jar + target: /opt/sonarqube/extensions/plugins/ecocode-python-plugin-1.4.0-SNAPSHOT.jar + - "extensions:/opt/sonarqube/extensions" + - "logs:/opt/sonarqube/logs" + - "data:/opt/sonarqube/data" + + db: + image: postgres:12 + container_name: postgresql_ecocode_python + networks: + - sonarnet + volumes: + - pg_data:/var/lib/postgresql/data + environment: + POSTGRES_USER: sonar + POSTGRES_PASSWORD: sonar + POSTGRES_DB: sonarqube + PGDATA: pg_data:/var/lib/postgresql/data/pgdata + +networks: + sonarnet: + driver: bridge + +volumes: + data: + logs: + extensions: + pg_data: diff --git a/pom.xml b/pom.xml new file mode 100644 index 0000000..ce00312 --- /dev/null +++ b/pom.xml @@ -0,0 +1,223 @@ + + + 4.0.0 + + io.ecocode + ecocode-python-plugin + 1.4.0-SNAPSHOT + sonar-plugin + + ecoCode - Python language + Provides rules to reduce the environmental footprint of your Python programs + https://github.com/green-code-initiative/ecoCode/tree/main/python-plugin + + + green-code-initiative + https://github.com/green-code-initiative + + + + GPL v3 + https://www.gnu.org/licenses/gpl-3.0.en.html + repo + + + + + GitHub + https://github.com/green-code-initiative/ecoCode-python/issues + + + + + 11 + ${java.version} + ${java.version} + + UTF-8 + ${encoding} + ${encoding} + + green-code-initiative + https://sonarcloud.io + + 9.4.0.54424 + 7.19.0.31550 + 4.3.0.11660 + + 1.21.0.505 + true + + 5.9.1 + 3.23.1 + 5.3.1 + + + 0.0.2 + + 2.5.0.1358 + + + + + + ${project.groupId} + ecocode-rules-specifications + ${ecocode-rules-specifications.version} + python + + + + org.sonarsource.python + sonar-python-plugin + ${sonarpython.version} + sonar-plugin + provided + + + + org.sonarsource.sonarqube + sonar-plugin-api + ${sonarqube.version} + provided + + + + org.sonarsource.python + python-checks-testkit + ${sonarpython.version} + test + + + + org.mockito + mockito-junit-jupiter + ${mockito.version} + test + + + + + + + + org.apache.maven.plugins + maven-compiler-plugin + 3.11.0 + + + org.apache.maven.plugins + maven-dependency-plugin + 3.6.0 + + + copy-bundle + package + + copy + + + + + ${project.groupId} + ${project.artifactId} + ${project.version} + jar + true + + + ../lib + + + + + + org.apache.maven.plugins + maven-surefire-plugin + 3.1.2 + + + org.jacoco + jacoco-maven-plugin + 0.8.10 + + file + false + + + + prepare-agent + + prepare-agent + + + + report + test + + report + + + + + + org.sonarsource.sonar-packaging-maven-plugin + sonar-packaging-maven-plugin + ${sonar-packaging.version} + true + + ecocodepython + ${project.name} + fr.greencodeinitiative.python.PythonPlugin + true + ${sonarqube.version} + ${java.version} + + + + org.apache.maven.plugins + maven-shade-plugin + 3.5.0 + + + + package + + shade + + + + + commons-*:* + + META-INF/** + + + + org.*:* + + META-INF/** + org/sonar/api/batch/sensor/** + javax/annotation/** + + + + com.*:* + + META-INF/** + + + + junit:* + + META-INF/** + + + + + + + + + + diff --git a/src/main/java/fr/greencodeinitiative/python/PythonPlugin.java b/src/main/java/fr/greencodeinitiative/python/PythonPlugin.java new file mode 100644 index 0000000..cb80125 --- /dev/null +++ b/src/main/java/fr/greencodeinitiative/python/PythonPlugin.java @@ -0,0 +1,28 @@ +/* + * Copyright (C) 2023 Green Code Initiative + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 3 of the License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ +package fr.greencodeinitiative.python; + +import org.sonar.api.Plugin; + +public class PythonPlugin implements Plugin { + + @Override + public void define(Context context) { + context.addExtension(PythonRuleRepository.class); + } + +} diff --git a/src/main/java/fr/greencodeinitiative/python/PythonRuleRepository.java b/src/main/java/fr/greencodeinitiative/python/PythonRuleRepository.java new file mode 100644 index 0000000..23ff4f5 --- /dev/null +++ b/src/main/java/fr/greencodeinitiative/python/PythonRuleRepository.java @@ -0,0 +1,69 @@ +/* + * Copyright (C) 2023 Green Code Initiative + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 3 of the License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ +package fr.greencodeinitiative.python; + +import fr.greencodeinitiative.python.checks.*; +import org.sonar.api.SonarRuntime; +import org.sonar.api.server.rule.RulesDefinition; +import org.sonar.plugins.python.api.PythonCustomRuleRepository; +import org.sonarsource.analyzer.commons.RuleMetadataLoader; + +import java.util.Arrays; +import java.util.List; + +public class PythonRuleRepository implements RulesDefinition, PythonCustomRuleRepository { + + public static final String LANGUAGE = "py"; + public static final String NAME = "ecoCode"; + public static final String RESOURCE_BASE_PATH = "io/ecocode/rules/python"; + public static final String REPOSITORY_KEY = "ecocode-python"; + + private final SonarRuntime sonarRuntime; + + public PythonRuleRepository(SonarRuntime sonarRuntime) { + this.sonarRuntime = sonarRuntime; + } + + @Override + public void define(Context context) { + NewRepository repository = context.createRepository(REPOSITORY_KEY, LANGUAGE).setName(NAME); + RuleMetadataLoader ruleMetadataLoader = new RuleMetadataLoader(RESOURCE_BASE_PATH, sonarRuntime); + ruleMetadataLoader.addRulesByAnnotatedClass(repository, (List) checkClasses()); + repository.done(); + } + + @Override + public String repositoryKey() { + return REPOSITORY_KEY; + } + + @Override + public List checkClasses() { + return Arrays.asList( + AvoidDoubleQuoteCheck.class, + AvoidGettersAndSetters.class, + AvoidGlobalVariableInFunctionCheck.class, + AvoidSQLRequestInLoop.class, + AvoidTryCatchFinallyCheck.class, + AvoidUnoptimizedVectorImagesCheck.class, + NoFunctionCallWhenDeclaringForLoop.class, + AvoidFullSQLRequest.class, + AvoidListComprehensionInIterations.class, + DetectUnoptimizedImageFormat.class + ); + } +} diff --git a/src/main/java/fr/greencodeinitiative/python/checks/AvoidDoubleQuoteCheck.java b/src/main/java/fr/greencodeinitiative/python/checks/AvoidDoubleQuoteCheck.java new file mode 100644 index 0000000..e6b1912 --- /dev/null +++ b/src/main/java/fr/greencodeinitiative/python/checks/AvoidDoubleQuoteCheck.java @@ -0,0 +1,24 @@ +package fr.greencodeinitiative.python.checks; + +import org.sonar.check.Rule; +import org.sonar.plugins.python.api.PythonSubscriptionCheck; +import org.sonar.plugins.python.api.SubscriptionContext; +import org.sonar.plugins.python.api.tree.StringLiteral; +import org.sonar.plugins.python.api.tree.Tree; + +@Rule(key = "EC66") +public class AvoidDoubleQuoteCheck extends PythonSubscriptionCheck { + public static final String MESSAGE_RULE = "Avoid using quotation mark (\"), prefer using simple quote (')"; + @Override + public void initialize(Context context) { + context.registerSyntaxNodeConsumer(Tree.Kind.STRING_LITERAL, this::visitNodeString); + } + + private void visitNodeString(SubscriptionContext subscriptionContext) { + StringLiteral stringLiteral = (StringLiteral) subscriptionContext.syntaxNode(); + + if (!stringLiteral.stringElements().isEmpty() && stringLiteral.stringElements().get(0).value().startsWith("\"")){ + subscriptionContext.addIssue(stringLiteral, MESSAGE_RULE); + } + } +} diff --git a/src/main/java/fr/greencodeinitiative/python/checks/AvoidFullSQLRequest.java b/src/main/java/fr/greencodeinitiative/python/checks/AvoidFullSQLRequest.java new file mode 100644 index 0000000..8c6d4ee --- /dev/null +++ b/src/main/java/fr/greencodeinitiative/python/checks/AvoidFullSQLRequest.java @@ -0,0 +1,68 @@ +package fr.greencodeinitiative.python.checks; + + +import java.util.ArrayList; +import java.util.Collection; +import java.util.HashMap; +import java.util.Map; +import java.util.regex.Pattern; + +import org.sonar.check.Rule; +import org.sonar.plugins.python.api.PythonSubscriptionCheck; +import org.sonar.plugins.python.api.SubscriptionContext; +import org.sonar.plugins.python.api.tree.StringElement; +import org.sonar.plugins.python.api.tree.StringLiteral; +import org.sonar.plugins.python.api.tree.Tree; +import org.sonarsource.analyzer.commons.annotations.DeprecatedRuleKey; + +@Rule(key = "EC74") +@DeprecatedRuleKey(repositoryKey = "gci-python", ruleKey = "S74") +public class AvoidFullSQLRequest extends PythonSubscriptionCheck { + + protected static final String MESSAGERULE = "Don't use the query SELECT * FROM"; + + // TODO DDC : create support to add in deployment th dependency com.google.re2j:re2j + // and replace "import java.util.regex.Pattern" by "import com.google.re2j.Pattern" + private static final Pattern PATTERN = Pattern.compile("(?i).*select.*\\*.*from.*"); + private static final Map> linesWithIssuesByFile = new HashMap<>(); + + + @Override + public void initialize(Context context) { + context.registerSyntaxNodeConsumer(Tree.Kind.STRING_LITERAL, this::visitNodeString); + } + + public void visitNodeString(SubscriptionContext ctx) { + StringLiteral stringLiteral = (StringLiteral) ctx.syntaxNode(); + stringLiteral.stringElements().forEach(stringElement -> checkIssue(stringElement, ctx)); + } + + public void checkIssue(StringElement stringElement, SubscriptionContext ctx) { + if (lineAlreadyHasThisIssue(stringElement, ctx)) return; + if (PATTERN.matcher(stringElement.value()).matches()) { + repport(stringElement, ctx); + } + } + + private void repport(StringElement stringElement, SubscriptionContext ctx) { + if (stringElement.firstToken() != null) { + final String classname = ctx.pythonFile().fileName(); + final int line = stringElement.firstToken().line(); + linesWithIssuesByFile.computeIfAbsent(classname, k -> new ArrayList<>()); + linesWithIssuesByFile.get(classname).add(line); + } + ctx.addIssue(stringElement, MESSAGERULE); + } + + private boolean lineAlreadyHasThisIssue(StringElement stringElement, SubscriptionContext ctx) { + if (stringElement.firstToken() != null) { + final String filename = ctx.pythonFile().fileName(); + final int line = stringElement.firstToken().line(); + + return linesWithIssuesByFile.containsKey(filename) + && linesWithIssuesByFile.get(filename).contains(line); + } + + return false; + } +} diff --git a/src/main/java/fr/greencodeinitiative/python/checks/AvoidGettersAndSetters.java b/src/main/java/fr/greencodeinitiative/python/checks/AvoidGettersAndSetters.java new file mode 100644 index 0000000..beb063d --- /dev/null +++ b/src/main/java/fr/greencodeinitiative/python/checks/AvoidGettersAndSetters.java @@ -0,0 +1,74 @@ +package fr.greencodeinitiative.python.checks; + +import java.util.List; +import java.util.stream.Collectors; + +import org.sonar.check.Rule; +import org.sonar.plugins.python.api.PythonSubscriptionCheck; +import org.sonar.plugins.python.api.SubscriptionContext; +import org.sonar.plugins.python.api.tree.AnyParameter; +import org.sonar.plugins.python.api.tree.AssignmentStatement; +import org.sonar.plugins.python.api.tree.FunctionDef; +import org.sonar.plugins.python.api.tree.ParameterList; +import org.sonar.plugins.python.api.tree.QualifiedExpression; +import org.sonar.plugins.python.api.tree.ReturnStatement; +import org.sonar.plugins.python.api.tree.Statement; +import org.sonar.plugins.python.api.tree.StatementList; +import org.sonar.plugins.python.api.tree.Tree; +import org.sonarsource.analyzer.commons.annotations.DeprecatedRuleKey; + +@Rule(key = "EC7") +@DeprecatedRuleKey(repositoryKey = "gci-python", ruleKey = "D7") +public class AvoidGettersAndSetters extends PythonSubscriptionCheck { + + public static final String DESCRIPTION = "Avoid creating getter and setter methods in classes"; + + @Override + public void initialize(Context context) { + context.registerSyntaxNodeConsumer(Tree.Kind.FUNCDEF, ctx -> { + FunctionDef functionDef = (FunctionDef) ctx.syntaxNode(); + StatementList statementList = functionDef.body(); + List statements = statementList.statements(); + if (functionDef.parent().parent().is(Tree.Kind.CLASSDEF)) { + checkAllGetters(statements, functionDef, ctx); + checkAllSetters(statements, functionDef, ctx); + } + }); + } + + public void checkAllSetters(List statements, FunctionDef functionDef, SubscriptionContext ctx) { + if (statements.size() == 1 && statements.get(0).is(Tree.Kind.ASSIGNMENT_STMT)) { + AssignmentStatement assignmentStatement = (AssignmentStatement) statements.get(0); + if (checkIfStatementIsQualifiedExpressionAndStartsWithSelfDot((QualifiedExpression) assignmentStatement.children().get(0).children().get(0))) { + // Check if assignedValue is a parameter of the function + ParameterList parameters = functionDef.parameters(); + if (parameters != null && !parameters.all().stream().filter(p -> checkAssignementFromParameter(assignmentStatement, p)).collect(Collectors.toList()).isEmpty()) { + ctx.addIssue(functionDef.defKeyword(), AvoidGettersAndSetters.DESCRIPTION); + } + } + } + } + + public void checkAllGetters(List statements, FunctionDef functionDef, SubscriptionContext ctx) { + Statement lastStatement = statements.get(statements.size() - 1); + if (lastStatement.is(Tree.Kind.RETURN_STMT)) { + List returnStatementChildren = ((ReturnStatement) lastStatement).children(); + if (returnStatementChildren.get(1).is(Tree.Kind.QUALIFIED_EXPR) && + checkIfStatementIsQualifiedExpressionAndStartsWithSelfDot((QualifiedExpression) returnStatementChildren.get(1))) { + ctx.addIssue(functionDef.defKeyword(), AvoidGettersAndSetters.DESCRIPTION); + } + } + } + + public boolean checkAssignementFromParameter(AssignmentStatement assignmentStatement, AnyParameter parameter) { + String parameterToString = parameter.firstToken().value(); + return assignmentStatement.assignedValue().firstToken().value().equalsIgnoreCase(parameterToString); + } + + public boolean checkIfStatementIsQualifiedExpressionAndStartsWithSelfDot(QualifiedExpression qualifiedExpression) { + List qualifedExpressionChildren = qualifiedExpression.children(); + return qualifedExpressionChildren.size() == 3 && + qualifedExpressionChildren.get(0).firstToken().value().equalsIgnoreCase("self") && + qualifedExpressionChildren.get(1).firstToken().value().equalsIgnoreCase("."); + } +} diff --git a/src/main/java/fr/greencodeinitiative/python/checks/AvoidGlobalVariableInFunctionCheck.java b/src/main/java/fr/greencodeinitiative/python/checks/AvoidGlobalVariableInFunctionCheck.java new file mode 100644 index 0000000..82bc46b --- /dev/null +++ b/src/main/java/fr/greencodeinitiative/python/checks/AvoidGlobalVariableInFunctionCheck.java @@ -0,0 +1,320 @@ +package fr.greencodeinitiative.python.checks; + +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +import org.sonar.check.Rule; +import org.sonar.plugins.python.api.PythonSubscriptionCheck; +import org.sonar.plugins.python.api.SubscriptionCheck; +import org.sonar.plugins.python.api.SubscriptionContext; +import org.sonar.plugins.python.api.symbols.Symbol; +import org.sonar.plugins.python.api.tree.AnnotatedAssignment; +import org.sonar.plugins.python.api.tree.ArgList; +import org.sonar.plugins.python.api.tree.AssertStatement; +import org.sonar.plugins.python.api.tree.AssignmentExpression; +import org.sonar.plugins.python.api.tree.AssignmentStatement; +import org.sonar.plugins.python.api.tree.AwaitExpression; +import org.sonar.plugins.python.api.tree.BinaryExpression; +import org.sonar.plugins.python.api.tree.CallExpression; +import org.sonar.plugins.python.api.tree.CompoundAssignmentStatement; +import org.sonar.plugins.python.api.tree.ComprehensionExpression; +import org.sonar.plugins.python.api.tree.ComprehensionFor; +import org.sonar.plugins.python.api.tree.ComprehensionIf; +import org.sonar.plugins.python.api.tree.ConditionalExpression; +import org.sonar.plugins.python.api.tree.DictCompExpression; +import org.sonar.plugins.python.api.tree.DictionaryLiteral; +import org.sonar.plugins.python.api.tree.ElseClause; +import org.sonar.plugins.python.api.tree.ExceptClause; +import org.sonar.plugins.python.api.tree.ExecStatement; +import org.sonar.plugins.python.api.tree.ExpressionList; +import org.sonar.plugins.python.api.tree.ExpressionStatement; +import org.sonar.plugins.python.api.tree.FileInput; +import org.sonar.plugins.python.api.tree.FinallyClause; +import org.sonar.plugins.python.api.tree.ForStatement; +import org.sonar.plugins.python.api.tree.FunctionDef; +import org.sonar.plugins.python.api.tree.IfStatement; +import org.sonar.plugins.python.api.tree.KeyValuePair; +import org.sonar.plugins.python.api.tree.LambdaExpression; +import org.sonar.plugins.python.api.tree.ListLiteral; +import org.sonar.plugins.python.api.tree.Name; +import org.sonar.plugins.python.api.tree.Parameter; +import org.sonar.plugins.python.api.tree.ParameterList; +import org.sonar.plugins.python.api.tree.ParenthesizedExpression; +import org.sonar.plugins.python.api.tree.PrintStatement; +import org.sonar.plugins.python.api.tree.RaiseStatement; +import org.sonar.plugins.python.api.tree.RegularArgument; +import org.sonar.plugins.python.api.tree.ReprExpression; +import org.sonar.plugins.python.api.tree.ReturnStatement; +import org.sonar.plugins.python.api.tree.SetLiteral; +import org.sonar.plugins.python.api.tree.StatementList; +import org.sonar.plugins.python.api.tree.SubscriptionExpression; +import org.sonar.plugins.python.api.tree.Tree; +import org.sonar.plugins.python.api.tree.TryStatement; +import org.sonar.plugins.python.api.tree.Tuple; +import org.sonar.plugins.python.api.tree.TupleParameter; +import org.sonar.plugins.python.api.tree.UnaryExpression; +import org.sonar.plugins.python.api.tree.UnpackingExpression; +import org.sonar.plugins.python.api.tree.WhileStatement; +import org.sonar.plugins.python.api.tree.YieldExpression; +import org.sonar.plugins.python.api.tree.YieldStatement; +import org.sonarsource.analyzer.commons.annotations.DeprecatedRuleKey; + +@Rule(key = "EC4") +@DeprecatedRuleKey(repositoryKey = "gci-python", ruleKey = "D4") +public class AvoidGlobalVariableInFunctionCheck extends PythonSubscriptionCheck { + + public static final String DESCRIPTION = "Use local variable (function/class scope) instead of global variable (application scope)"; + + private List globalVariables; + private List definedLocalVariables; + private Map usedLocalVariables; + + @Override + public void initialize(SubscriptionCheck.Context context) { + globalVariables = new ArrayList<>(); + context.registerSyntaxNodeConsumer(Tree.Kind.FILE_INPUT, this::visitFileInput); + context.registerSyntaxNodeConsumer(Tree.Kind.FUNCDEF, this::visitFuncDef); + } + + public void visitFileInput(SubscriptionContext ctx) { + FileInput fileInput = (FileInput) ctx.syntaxNode(); + fileInput.globalVariables().stream().filter(v -> v.is(Symbol.Kind.OTHER)).forEach(v -> this.globalVariables.add(v.name())); + } + + void visitFuncDef(SubscriptionContext ctx) { + this.definedLocalVariables = new ArrayList<>(); + this.usedLocalVariables = new HashMap<>(); + + FunctionDef functionDef = (FunctionDef) ctx.syntaxNode(); + + ParameterList parameterList = functionDef.parameters(); + if (parameterList != null) { + parameterList.nonTuple().forEach(p -> extractVariablesFromExpression(p, true)); + } + + functionDef.body().statements() + .forEach(s -> extractVariablesFromExpression(s, false)); + + this.usedLocalVariables.entrySet().stream() + .filter(e -> !this.definedLocalVariables.contains(e.getValue()) && this.globalVariables.contains(e.getValue())) + .forEach(e -> ctx.addIssue(e.getKey(), DESCRIPTION)); + } + + void extractVariablesFromExpression(Tree element, boolean isAssigned) { + if (element == null) { + return; + } + + switch (element.getKind()) { + case REGULAR_ARGUMENT: + extractVariablesFromExpression(((RegularArgument) element).expression(), isAssigned); + break; + case ARG_LIST: + ((ArgList) element).arguments().forEach(a -> extractVariablesFromExpression(a, isAssigned)); + break; + case ANNOTATED_ASSIGNMENT: + AnnotatedAssignment annotatedAssignment = (AnnotatedAssignment) element; + extractVariablesFromExpression(annotatedAssignment.variable(), true); + extractVariablesFromExpression(annotatedAssignment.assignedValue(), false); + break; + case ASSERT_STMT: + AssertStatement assertStatement = (AssertStatement) element; + extractVariablesFromExpression(assertStatement.condition(), false); + extractVariablesFromExpression(assertStatement.message(), false); + break; + case ASSIGNMENT_STMT: + AssignmentStatement assignmentStatement = (AssignmentStatement) element; + assignmentStatement.lhsExpressions().forEach(e -> extractVariablesFromExpression(e, true)); + extractVariablesFromExpression(assignmentStatement.assignedValue(), false); + break; + case CALL_EXPR: + extractVariablesFromExpression(((CallExpression) element).argumentList(), isAssigned); + break; + case CONDITIONAL_EXPR: + ConditionalExpression conditionalExpression = (ConditionalExpression) element; + extractVariablesFromExpression(conditionalExpression.trueExpression(), isAssigned); + extractVariablesFromExpression(conditionalExpression.falseExpression(), false); + extractVariablesFromExpression(conditionalExpression.condition(), isAssigned); + break; + case COMPOUND_ASSIGNMENT: + CompoundAssignmentStatement compoundAssignmentStatement = (CompoundAssignmentStatement) element; + extractVariablesFromExpression(compoundAssignmentStatement.lhsExpression(), true); + extractVariablesFromExpression(compoundAssignmentStatement.rhsExpression(), false); + break; + case DICTIONARY_LITERAL: + ((DictionaryLiteral) element).elements().forEach(e -> extractVariablesFromExpression(e, false)); + break; + case ELSE_CLAUSE: + extractVariablesFromExpression(((ElseClause) element).body(), isAssigned); + break; + case EXCEPT_CLAUSE: + extractVariablesFromExpression(((ExceptClause) element).body(), isAssigned); + break; + case EXEC_STMT: + ExecStatement execStatement = (ExecStatement) element; + extractVariablesFromExpression(execStatement.expression(), isAssigned); + extractVariablesFromExpression(execStatement.globalsExpression(), isAssigned); + extractVariablesFromExpression(execStatement.localsExpression(), isAssigned); + break; + case EXPRESSION_LIST: + ((ExpressionList) element).expressions().forEach(e -> extractVariablesFromExpression(e, isAssigned)); + break; + case EXPRESSION_STMT: + ((ExpressionStatement) element).expressions().forEach(e -> extractVariablesFromExpression(e, isAssigned)); + break; + case FILE_INPUT: + extractVariablesFromExpression(((FileInput) element).statements(), isAssigned); + break; + case FINALLY_CLAUSE: + extractVariablesFromExpression(((FinallyClause) element).body(), isAssigned); + break; + case FOR_STMT: + ForStatement forStatement = ((ForStatement) element); + forStatement.expressions().forEach(e -> extractVariablesFromExpression(e, true)); + forStatement.testExpressions().forEach(e -> extractVariablesFromExpression(e, false)); + extractVariablesFromExpression(forStatement.body(), isAssigned); + extractVariablesFromExpression(forStatement.elseClause(), isAssigned); + break; + case IF_STMT: + IfStatement ifStatement = (IfStatement) element; + extractVariablesFromExpression(ifStatement.condition(), false); + extractVariablesFromExpression(ifStatement.body(), isAssigned); + extractVariablesFromExpression(ifStatement.elseBranch(), isAssigned); + ifStatement.elifBranches().forEach(b -> extractVariablesFromExpression(b, isAssigned)); + break; + case LAMBDA: + extractVariablesFromExpression(((LambdaExpression) element).expression(), isAssigned); + break; + case LIST_LITERAL: + extractVariablesFromExpression(((ListLiteral) element).elements(), false); + break; + case NAME: + if (isAssigned) { + this.definedLocalVariables.add(((Name) element).name()); + } else { + this.usedLocalVariables.put(element, ((Name) element).name()); + } + break; + case PRINT_STMT: + ((PrintStatement) element).expressions().forEach(e -> extractVariablesFromExpression(e, false)); + break; + case RAISE_STMT: + RaiseStatement raiseStatement = (RaiseStatement) element; + extractVariablesFromExpression(raiseStatement.fromExpression(), false); + raiseStatement.expressions().forEach(e -> extractVariablesFromExpression(e, false)); + break; + case REPR: + extractVariablesFromExpression(((ReprExpression) element).expressionList(), isAssigned); + break; + case RETURN_STMT: + ((ReturnStatement) element).expressions().forEach(e -> extractVariablesFromExpression(e, false)); + break; + case SET_LITERAL: + ((SetLiteral) element).elements().forEach(e -> extractVariablesFromExpression(e, false)); + break; + case STATEMENT_LIST: + ((StatementList) element).statements().forEach(s -> extractVariablesFromExpression(s, isAssigned)); + break; + case TRY_STMT: + TryStatement tryStatement = (TryStatement) element; + extractVariablesFromExpression(tryStatement.body(), isAssigned); + tryStatement.exceptClauses().forEach(c -> extractVariablesFromExpression(c, isAssigned)); + extractVariablesFromExpression(tryStatement.elseClause(), isAssigned); + extractVariablesFromExpression(tryStatement.finallyClause(), isAssigned); + break; + case PARAMETER: + Parameter parameter = (Parameter) element; + extractVariablesFromExpression(parameter.name(), true); + extractVariablesFromExpression(parameter.defaultValue(), false); + break; + case TUPLE_PARAMETER: + ((TupleParameter) element).parameters().forEach(p -> extractVariablesFromExpression(p, isAssigned)); + break; + case PARAMETER_LIST: + ((ParameterList) element).all().forEach(a -> extractVariablesFromExpression(a, true)); + break; + case WHILE_STMT: + WhileStatement whileStatement = (WhileStatement) element; + extractVariablesFromExpression(whileStatement.condition(), false); + extractVariablesFromExpression(whileStatement.body(), isAssigned); + extractVariablesFromExpression(whileStatement.elseClause(), isAssigned); + break; + case YIELD_EXPR: + ((YieldExpression) element).expressions().forEach(e -> extractVariablesFromExpression(e, isAssigned)); + break; + case YIELD_STMT: + extractVariablesFromExpression(((YieldStatement) element).yieldExpression(), isAssigned); + break; + case PARENTHESIZED: + extractVariablesFromExpression(((ParenthesizedExpression) element).expression(), isAssigned); + break; + case UNPACKING_EXPR: + extractVariablesFromExpression(((UnpackingExpression) element).expression(), isAssigned); + break; + case AWAIT: + extractVariablesFromExpression(((AwaitExpression) element).expression(), false); + break; + case TUPLE: + ((Tuple) element).elements().forEach(e -> extractVariablesFromExpression(e, isAssigned)); + break; + case DICT_COMPREHENSION: + extractVariablesFromExpression(((DictCompExpression) element).comprehensionFor(), false); + break; + case LIST_COMPREHENSION: + case SET_COMPREHENSION: + case GENERATOR_EXPR: + extractVariablesFromExpression(((ComprehensionExpression) element).resultExpression(), false); + extractVariablesFromExpression(((ComprehensionExpression) element).comprehensionFor(), true); + break; + case COMP_FOR: + extractVariablesFromExpression(((ComprehensionFor) element).loopExpression(), true); + extractVariablesFromExpression(((ComprehensionFor) element).iterable(), false); + break; + case COMP_IF: + extractVariablesFromExpression(((ComprehensionIf) element).condition(), false); + break; + case SUBSCRIPTION: + extractVariablesFromExpression(((SubscriptionExpression) element).object(), false); + extractVariablesFromExpression(((SubscriptionExpression) element).subscripts(), false); + break; + case PLUS: + case MINUS: + case MULTIPLICATION: + case DIVISION: + case FLOOR_DIVISION: + case MODULO: + case MATRIX_MULTIPLICATION: + case SHIFT_EXPR: + case BITWISE_AND: + case BITWISE_OR: + case BITWISE_XOR: + case AND: + case OR: + case COMPARISON: + case POWER: + BinaryExpression binaryExpression = (BinaryExpression) element; + extractVariablesFromExpression(binaryExpression.leftOperand(), false); + extractVariablesFromExpression(binaryExpression.rightOperand(), false); + break; + case UNARY_PLUS: + case UNARY_MINUS: + case BITWISE_COMPLEMENT: + case NOT: + extractVariablesFromExpression(((UnaryExpression) element).expression(), false); + break; + case ASSIGNMENT_EXPRESSION: + AssignmentExpression assignmentExpression = (AssignmentExpression) element; + extractVariablesFromExpression(assignmentExpression.lhsName(), true); + extractVariablesFromExpression(assignmentExpression.expression(), false); + break; + case KEY_VALUE_PAIR: + KeyValuePair keyValuePair = (KeyValuePair) element; + extractVariablesFromExpression(keyValuePair.key(), true); + extractVariablesFromExpression(keyValuePair.value(), false); + break; + default: + } + } +} diff --git a/src/main/java/fr/greencodeinitiative/python/checks/AvoidListComprehensionInIterations.java b/src/main/java/fr/greencodeinitiative/python/checks/AvoidListComprehensionInIterations.java new file mode 100644 index 0000000..917d053 --- /dev/null +++ b/src/main/java/fr/greencodeinitiative/python/checks/AvoidListComprehensionInIterations.java @@ -0,0 +1,71 @@ +package fr.greencodeinitiative.python.checks; + +import org.sonar.check.Rule; +import org.sonar.plugins.python.api.PythonSubscriptionCheck; +import org.sonar.plugins.python.api.SubscriptionContext; +import org.sonar.plugins.python.api.symbols.Symbol; +import org.sonar.plugins.python.api.tree.Expression; +import org.sonar.plugins.python.api.tree.CallExpression; +import org.sonar.plugins.python.api.tree.ForStatement; +import org.sonar.plugins.python.api.tree.Tree; +import org.sonar.plugins.python.api.tree.RegularArgument; + +import java.util.Objects; + +import static org.sonar.plugins.python.api.tree.Tree.Kind.CALL_EXPR; +import static org.sonar.plugins.python.api.tree.Tree.Kind.FOR_STMT; +import static org.sonar.plugins.python.api.tree.Tree.Kind.LIST_COMPREHENSION; +import static org.sonar.plugins.python.api.tree.Tree.Kind.REGULAR_ARGUMENT; + +@Rule(key = "EC404") +public class AvoidListComprehensionInIterations extends PythonSubscriptionCheck { + + public static final String DESCRIPTION = "Use generator comprehension instead of list comprehension in for loop declaration"; + + @Override + public void initialize(Context context) { + context.registerSyntaxNodeConsumer(FOR_STMT, this::visitIteration); + } + + private void visitIteration(SubscriptionContext context) { + ForStatement forStatement = (ForStatement) context.syntaxNode(); + + Expression forTestExpression = forStatement.testExpressions().get(0); + if (forTestExpression.is(LIST_COMPREHENSION)) { + context.addIssue(forTestExpression.firstToken(), DESCRIPTION); + } else if (forTestExpression.is(CALL_EXPR)) { + CallExpression callExpression = (CallExpression) forTestExpression; + visitCallExpression(context, callExpression); + } + } + + private void visitCallExpression(SubscriptionContext context, CallExpression callExpression){ + switch (getFunctionNameFromCallExpression(callExpression)) { + case "zip": + case "filter": + case "enumerate": + Objects.requireNonNull(callExpression.argumentList()). + arguments().forEach(e -> visitFunctionArgument(context, e)); + break; + default: + break; + } + } + + private void visitFunctionArgument(SubscriptionContext context, Tree argument) { + if (argument.is(REGULAR_ARGUMENT)) { + Expression expression = ((RegularArgument)argument).expression(); + if (expression.is(LIST_COMPREHENSION)) { + context.addIssue(expression.firstToken(), DESCRIPTION); + } else if (expression.is(CALL_EXPR)) { + CallExpression callExpression = (CallExpression) expression; + visitCallExpression(context, callExpression); + } + } + } + + private String getFunctionNameFromCallExpression(CallExpression callExpression) { + Symbol symbol = callExpression.calleeSymbol(); + return symbol != null && symbol.name() != null ? symbol.name() : ""; + } +} diff --git a/src/main/java/fr/greencodeinitiative/python/checks/AvoidSQLRequestInLoop.java b/src/main/java/fr/greencodeinitiative/python/checks/AvoidSQLRequestInLoop.java new file mode 100644 index 0000000..a2bb207 --- /dev/null +++ b/src/main/java/fr/greencodeinitiative/python/checks/AvoidSQLRequestInLoop.java @@ -0,0 +1,84 @@ +package fr.greencodeinitiative.python.checks; + +import java.util.Arrays; +import java.util.HashSet; +import java.util.List; +import java.util.Objects; +import java.util.Set; + +import org.sonar.check.Rule; +import org.sonar.plugins.python.api.PythonSubscriptionCheck; +import org.sonar.plugins.python.api.SubscriptionContext; +import org.sonar.plugins.python.api.symbols.Symbol; +import org.sonar.plugins.python.api.tree.AliasedName; +import org.sonar.plugins.python.api.tree.BaseTreeVisitor; +import org.sonar.plugins.python.api.tree.CallExpression; +import org.sonar.plugins.python.api.tree.FileInput; +import org.sonar.plugins.python.api.tree.Name; +import org.sonar.plugins.python.api.tree.QualifiedExpression; +import org.sonar.plugins.python.api.tree.Tree; +import org.sonarsource.analyzer.commons.annotations.DeprecatedRuleKey; + +@Rule(key = "EC72") +@DeprecatedRuleKey(repositoryKey = "gci-python", ruleKey = "S72") +public class AvoidSQLRequestInLoop extends PythonSubscriptionCheck { + + // TODO: Handle ORM lib + private static final List SQL_LIBS = Arrays.asList("cx_Oracle", "mysql.connector", "psycopg2", "pymssql", "pyodbc", "sqlite3"); + + protected static final String MESSAGE_RULE = "Avoid performing SQL queries within a loop"; + + private boolean isUsingSqlLib = false; + + @Override + public void initialize(Context context) { + context.registerSyntaxNodeConsumer(Tree.Kind.FILE_INPUT, this::visitFile); + context.registerSyntaxNodeConsumer(Tree.Kind.CALL_EXPR, this::checkCallExpression); + } + + private void visitFile(SubscriptionContext ctx) { + FileInput tree = (FileInput) ctx.syntaxNode(); + SymbolsFromImport visitor = new SymbolsFromImport(); + tree.accept(visitor); + visitor.symbols.stream() + .filter(Objects::nonNull) + .map(Symbol::fullyQualifiedName) + .filter(Objects::nonNull) + .forEach(qualifiedName -> { + if (SQL_LIBS.contains(qualifiedName)) { + isUsingSqlLib = true; + } + }); + } + + private static class SymbolsFromImport extends BaseTreeVisitor { + private final Set symbols = new HashSet<>(); + + @Override + public void visitAliasedName(AliasedName aliasedName) { + List names = aliasedName.dottedName().names(); + symbols.add(names.get(names.size() - 1).symbol()); + } + } + + private void checkCallExpression(SubscriptionContext context) { + CallExpression expression = (CallExpression) context.syntaxNode(); + + if (expression.callee().is(Tree.Kind.QUALIFIED_EXPR)) { + String name = ((QualifiedExpression) expression.callee()).name().name(); + if (isUsingSqlLib && "execute".equals(name) && hasLoopParent(expression)) { + context.addIssue(expression, AvoidSQLRequestInLoop.MESSAGE_RULE); + } + } + } + + private boolean hasLoopParent(Tree tree) { + for (Tree parent = tree.parent(); parent != null; parent = parent.parent()) { + Tree.Kind kind = parent.getKind(); + if (kind == Tree.Kind.FOR_STMT || kind == Tree.Kind.WHILE_STMT) { + return true; + } + } + return false; + } +} diff --git a/src/main/java/fr/greencodeinitiative/python/checks/AvoidTryCatchFinallyCheck.java b/src/main/java/fr/greencodeinitiative/python/checks/AvoidTryCatchFinallyCheck.java new file mode 100644 index 0000000..be801c4 --- /dev/null +++ b/src/main/java/fr/greencodeinitiative/python/checks/AvoidTryCatchFinallyCheck.java @@ -0,0 +1,27 @@ +package fr.greencodeinitiative.python.checks; + +import org.sonar.check.Rule; +import org.sonar.plugins.python.api.PythonSubscriptionCheck; +import org.sonar.plugins.python.api.SubscriptionContext; +import org.sonar.plugins.python.api.tree.Tree; +import org.sonar.plugins.python.api.tree.TryStatement; +import org.sonarsource.analyzer.commons.annotations.DeprecatedRuleKey; + +@Rule(key = "EC34") +@DeprecatedRuleKey(repositoryKey = "gci-python", ruleKey = "S34") +public class AvoidTryCatchFinallyCheck extends PythonSubscriptionCheck { + + public static final String DESCRIPTION = "Avoid the use of try-catch"; + + @Override + public void initialize(Context context) { + context.registerSyntaxNodeConsumer(Tree.Kind.TRY_STMT, this::visitNode); + } + + public void visitNode(SubscriptionContext ctx) { + TryStatement tryStatement = (TryStatement) ctx.syntaxNode(); + ctx.addIssue(tryStatement.tryKeyword(), DESCRIPTION); + + } + +} diff --git a/src/main/java/fr/greencodeinitiative/python/checks/AvoidUnoptimizedVectorImagesCheck.java b/src/main/java/fr/greencodeinitiative/python/checks/AvoidUnoptimizedVectorImagesCheck.java new file mode 100644 index 0000000..f3a9c36 --- /dev/null +++ b/src/main/java/fr/greencodeinitiative/python/checks/AvoidUnoptimizedVectorImagesCheck.java @@ -0,0 +1,72 @@ +package fr.greencodeinitiative.python.checks; + +import java.util.regex.Matcher; +import java.util.regex.Pattern; + +import org.sonar.check.Rule; +import org.sonar.plugins.python.api.PythonSubscriptionCheck; +import org.sonar.plugins.python.api.SubscriptionContext; +import org.sonar.plugins.python.api.tree.*; + +@Rule(key = "EC10") +public class AvoidUnoptimizedVectorImagesCheck extends PythonSubscriptionCheck { + + public static final String DESCRIPTION = "Avoid using unoptimized vector images"; + private static final Pattern LAYERS_PATTERN = Pattern.compile(""); + + @Override + public void initialize(Context ctx) { + ctx.registerSyntaxNodeConsumer(Tree.Kind.STRING_ELEMENT, this::checkSVG); + } + + private void checkSVG(SubscriptionContext ctx) { + StringElement stringLiteral = (StringElement) ctx.syntaxNode(); + checkComments(stringLiteral, ctx); + checkLayers(stringLiteral, ctx); + checkNamespaces(stringLiteral, ctx); + checkMetadata(stringLiteral, ctx); + } + + private void checkComments(StringElement str, SubscriptionContext ctx) { + if (isSvgTagNotDetected(str)) + return; + + if (str.value().contains("")) { + ctx.addIssue(str, DESCRIPTION); + } + } + + private void checkLayers(StringElement str, SubscriptionContext ctx) { + if (isSvgTagNotDetected(str)) + return; + + Matcher matcher = LAYERS_PATTERN.matcher(str.value()); + int matches = 0; + while (matcher.find()) matches++; + if (matches > 1) { // if at least 2 finds, create an issue + ctx.addIssue(str, DESCRIPTION); + } + } + + private void checkNamespaces(StringElement str, SubscriptionContext ctx) { + if (isSvgTagNotDetected(str)) + return; + + if (str.value().contains("xmlns:") && !str.value().contains("xmlns:svg=")) { + ctx.addIssue(str, DESCRIPTION); + } + } + + private void checkMetadata(StringElement str, SubscriptionContext ctx) { + if (isSvgTagNotDetected(str)) + return; + + if (str.value().contains("")) { + ctx.addIssue(str, DESCRIPTION); + } + } + + private boolean isSvgTagNotDetected(StringElement str) { + return !str.value().contains(""); + } +} diff --git a/src/main/java/fr/greencodeinitiative/python/checks/DetectUnoptimizedImageFormat.java b/src/main/java/fr/greencodeinitiative/python/checks/DetectUnoptimizedImageFormat.java new file mode 100644 index 0000000..a69599a --- /dev/null +++ b/src/main/java/fr/greencodeinitiative/python/checks/DetectUnoptimizedImageFormat.java @@ -0,0 +1,35 @@ +package fr.greencodeinitiative.python.checks; + +import org.sonar.check.Rule; +import org.sonar.plugins.python.api.PythonSubscriptionCheck; +import org.sonar.plugins.python.api.SubscriptionContext; +import org.sonar.plugins.python.api.tree.StringLiteral; +import org.sonar.plugins.python.api.tree.Tree; + +import java.util.regex.Matcher; +import java.util.regex.Pattern; + +@Rule(key = "EC203") +public class DetectUnoptimizedImageFormat extends PythonSubscriptionCheck { + + protected static final String RULE_KEY = "EC203"; + protected static final String MESSAGERULE = "Detect unoptimized image format"; + protected static final String MESSAGEERROR = "If possible, the utilisation of svg image format (or html tag) is recommended over other image format."; + protected static final Pattern IMGEXTENSION = Pattern.compile("\\.(bmp|ico|tiff|webp|png|jpg|jpeg|jfif|pjpeg|pjp|gif|avif|apng)"); + + @Override + public void initialize(Context context) { + context.registerSyntaxNodeConsumer(Tree.Kind.STRING_LITERAL, this::visitNodeString); + } + + public void visitNodeString(SubscriptionContext ctx) { + if (ctx.syntaxNode().is(Tree.Kind.STRING_LITERAL)) { + final StringLiteral stringLiteral = (StringLiteral) ctx.syntaxNode(); + final String strValue = stringLiteral.trimmedQuotesValue(); + final Matcher matcher = IMGEXTENSION.matcher(strValue); + if(matcher.find()) { + ctx.addIssue(stringLiteral, MESSAGEERROR); + } + } + } +} diff --git a/src/main/java/fr/greencodeinitiative/python/checks/NoFunctionCallWhenDeclaringForLoop.java b/src/main/java/fr/greencodeinitiative/python/checks/NoFunctionCallWhenDeclaringForLoop.java new file mode 100644 index 0000000..b0bf302 --- /dev/null +++ b/src/main/java/fr/greencodeinitiative/python/checks/NoFunctionCallWhenDeclaringForLoop.java @@ -0,0 +1,24 @@ +package fr.greencodeinitiative.python.checks; + +import org.sonar.check.Rule; +import org.sonar.plugins.python.api.PythonSubscriptionCheck; +import org.sonar.plugins.python.api.tree.CallExpression; +import org.sonar.plugins.python.api.tree.Tree; +import org.sonarsource.analyzer.commons.annotations.DeprecatedRuleKey; + +@Rule(key = "EC69") +@DeprecatedRuleKey(repositoryKey = "gci-python", ruleKey = "S69") +public class NoFunctionCallWhenDeclaringForLoop extends PythonSubscriptionCheck { + + public static final String DESCRIPTION = "Do not call a function when declaring a for-type loop"; + + @Override + public void initialize(Context context) { + context.registerSyntaxNodeConsumer(Tree.Kind.CALL_EXPR, ctx -> { + CallExpression callExpression = (CallExpression) ctx.syntaxNode(); + if (callExpression.parent().getKind() == Tree.Kind.FOR_STMT) { + ctx.addIssue(callExpression, NoFunctionCallWhenDeclaringForLoop.DESCRIPTION); + } + }); + } +} diff --git a/src/main/java/fr/greencodeinitiative/python/package-info.java b/src/main/java/fr/greencodeinitiative/python/package-info.java new file mode 100644 index 0000000..51a7a57 --- /dev/null +++ b/src/main/java/fr/greencodeinitiative/python/package-info.java @@ -0,0 +1,21 @@ +/* + * Copyright (C) 2023 Green Code Initiative + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 3 of the License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ +@ParametersAreNonnullByDefault +package fr.greencodeinitiative.python; + +import javax.annotation.ParametersAreNonnullByDefault; + diff --git a/src/test/java/fr/greencodeinitiative/python/PythonPluginTest.java b/src/test/java/fr/greencodeinitiative/python/PythonPluginTest.java new file mode 100644 index 0000000..e270ad4 --- /dev/null +++ b/src/test/java/fr/greencodeinitiative/python/PythonPluginTest.java @@ -0,0 +1,42 @@ +/* + * Copyright (C) 2023 Green Code Initiative + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 3 of the License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ +package fr.greencodeinitiative.python; + +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.sonar.api.Plugin; +import org.sonar.api.SonarRuntime; + +import static org.assertj.core.api.Assertions.assertThat; +import static org.mockito.Mockito.mock; + +class PythonPluginTest { + private Plugin.Context context; + + @BeforeEach + void init() { + SonarRuntime sonarRuntime = mock(SonarRuntime.class); + context = new Plugin.Context(sonarRuntime); + new PythonPlugin().define(context); + } + + @Test + void test() { + assertThat(context.getExtensions()).hasSize(1); + } + +} diff --git a/src/test/java/fr/greencodeinitiative/python/PythonRuleRepositoryTest.java b/src/test/java/fr/greencodeinitiative/python/PythonRuleRepositoryTest.java new file mode 100644 index 0000000..714ef27 --- /dev/null +++ b/src/test/java/fr/greencodeinitiative/python/PythonRuleRepositoryTest.java @@ -0,0 +1,103 @@ +/* + * Copyright (C) 2023 Green Code Initiative + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 3 of the License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ +package fr.greencodeinitiative.python; + +import org.assertj.core.api.SoftAssertions; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.DisplayName; +import org.junit.jupiter.api.Test; +import org.sonar.api.SonarRuntime; +import org.sonar.api.server.rule.RulesDefinition; +import org.sonar.api.utils.Version; + +import static org.assertj.core.api.Assertions.assertThat; +import static org.assertj.core.api.Assertions.fail; +import static org.mockito.Mockito.doReturn; +import static org.mockito.Mockito.mock; + +class PythonRuleRepositoryTest { + + private RulesDefinition.Repository repository; + + @BeforeEach + void init() { + // TODO: Remove this check after Git repo split + /* + On an IDE (like IntelliJ), if the developer runs the unit tests without building/generating the Maven goals on the + "ecocode-rules-specifications" module before, the unit tests will not see the generated HTML descriptions (from ASCIIDOC files). + The developer must therefore configure his IDE to build the `ecocode-rules-specifications` module before launching the Tests. + + When the `python-plugin` submodule is in a specific Git repository, `ecocode-rules-specifications` will be fetched from a classic + external Maven dependency. There will therefore no longer be any need to perform this specific configuration. + */ + if (PythonRuleRepository.class.getResource("/io/ecocode/rules/python/EC4.json") == null) { + String message = "'ecocode-rules-specification' resources corrupted. Please check build of 'ecocode-rules-specification' module"; + if (System.getProperties().keySet().stream().anyMatch(k -> k.toString().startsWith("idea."))) { + message += "\n\nOn 'IntelliJ IDEA':" + + "\n1. go to settings :" + + "\n > Build, Execution, Deployment > Build Tools > Maven > Runner" + + "\n2. check option:" + + "\n > Delegate IDE build/run actions to Maven" + + "\n3. Click on menu: " + + "\n > Build > Build Project" + ; + } + fail(message); + } + + final SonarRuntime sonarRuntime = mock(SonarRuntime.class); + doReturn(Version.create(0, 0)).when(sonarRuntime).getApiVersion(); + PythonRuleRepository rulesDefinition = new PythonRuleRepository(sonarRuntime); + RulesDefinition.Context context = new RulesDefinition.Context(); + rulesDefinition.define(context); + repository = context.repository(rulesDefinition.repositoryKey()); + } + + @Test + @DisplayName("Test repository metadata") + void testMetadata() { + assertThat(repository.name()).isEqualTo("ecoCode"); + assertThat(repository.language()).isEqualTo("py"); + assertThat(repository.key()).isEqualTo("ecocode-python"); + } + + @Test + void testRegistredRules() { + assertThat(repository.rules()).hasSize(10); + } + + @Test + @DisplayName("All rule keys must be prefixed by 'EC'") + void testRuleKeyPrefix() { + SoftAssertions assertions = new SoftAssertions(); + repository.rules().forEach( + rule -> assertions.assertThat(rule.key()).startsWith("EC") + ); + assertions.assertAll(); + } + + @Test + void testAllRuleParametersHaveDescription() { + SoftAssertions assertions = new SoftAssertions(); + repository.rules().stream() + .flatMap(rule -> rule.params().stream()) + .forEach(param -> assertions.assertThat(param.description()) + .as("description for " + param.key()) + .isNotEmpty()); + assertions.assertAll(); + } +} diff --git a/src/test/java/fr/greencodeinitiative/python/checks/AvoidDoubleQuoteTest.java b/src/test/java/fr/greencodeinitiative/python/checks/AvoidDoubleQuoteTest.java new file mode 100644 index 0000000..1079b10 --- /dev/null +++ b/src/test/java/fr/greencodeinitiative/python/checks/AvoidDoubleQuoteTest.java @@ -0,0 +1,11 @@ +package fr.greencodeinitiative.python.checks; + +import org.junit.Test; +import org.sonar.python.checks.utils.PythonCheckVerifier; + +public class AvoidDoubleQuoteTest { + @Test + public void test() { + PythonCheckVerifier.verify("src/test/resources/checks/avoidDoubleQuoteCheck.py", new AvoidDoubleQuoteCheck()); + } +} diff --git a/src/test/java/fr/greencodeinitiative/python/checks/AvoidFullSQLRequestTest.java b/src/test/java/fr/greencodeinitiative/python/checks/AvoidFullSQLRequestTest.java new file mode 100644 index 0000000..e03a71f --- /dev/null +++ b/src/test/java/fr/greencodeinitiative/python/checks/AvoidFullSQLRequestTest.java @@ -0,0 +1,12 @@ +package fr.greencodeinitiative.python.checks; + +import org.junit.Test; +import org.sonar.python.checks.utils.PythonCheckVerifier; + +public class AvoidFullSQLRequestTest { + + @Test + public void test() { + PythonCheckVerifier.verify("src/test/resources/checks/avoidFullSQLRequest.py", new AvoidFullSQLRequest()); + } +} diff --git a/src/test/java/fr/greencodeinitiative/python/checks/AvoidGettersAndSettersTest.java b/src/test/java/fr/greencodeinitiative/python/checks/AvoidGettersAndSettersTest.java new file mode 100644 index 0000000..26d7b4d --- /dev/null +++ b/src/test/java/fr/greencodeinitiative/python/checks/AvoidGettersAndSettersTest.java @@ -0,0 +1,12 @@ +package fr.greencodeinitiative.python.checks; + +import org.junit.Test; +import org.sonar.python.checks.utils.PythonCheckVerifier; + +public class AvoidGettersAndSettersTest { + + @Test + public void test() { + PythonCheckVerifier.verify("src/test/resources/checks/avoidGettersAndSetters.py", new AvoidGettersAndSetters()); + } +} diff --git a/src/test/java/fr/greencodeinitiative/python/checks/AvoidGlobalVariableInFunctionCheckTest.java b/src/test/java/fr/greencodeinitiative/python/checks/AvoidGlobalVariableInFunctionCheckTest.java new file mode 100644 index 0000000..c58ed4b --- /dev/null +++ b/src/test/java/fr/greencodeinitiative/python/checks/AvoidGlobalVariableInFunctionCheckTest.java @@ -0,0 +1,11 @@ +package fr.greencodeinitiative.python.checks; + +import org.junit.Test; +import org.sonar.python.checks.utils.PythonCheckVerifier; + +public class AvoidGlobalVariableInFunctionCheckTest { + @Test + public void test() { + PythonCheckVerifier.verify("src/test/resources/checks/avoidGlobalVariableInFunction.py", new AvoidGlobalVariableInFunctionCheck()); + } +} diff --git a/src/test/java/fr/greencodeinitiative/python/checks/AvoidListComprehensionInIterationsTest.java b/src/test/java/fr/greencodeinitiative/python/checks/AvoidListComprehensionInIterationsTest.java new file mode 100644 index 0000000..8e722c2 --- /dev/null +++ b/src/test/java/fr/greencodeinitiative/python/checks/AvoidListComprehensionInIterationsTest.java @@ -0,0 +1,11 @@ +package fr.greencodeinitiative.python.checks; + +import org.junit.Test; +import org.sonar.python.checks.utils.PythonCheckVerifier; + +public class AvoidListComprehensionInIterationsTest { + @Test + public void test() { + PythonCheckVerifier.verify("src/test/resources/checks/AvoidListComprehensionInIterations.py", new AvoidListComprehensionInIterations()); + } +} diff --git a/src/test/java/fr/greencodeinitiative/python/checks/AvoidSQLRequestInLoopTest.java b/src/test/java/fr/greencodeinitiative/python/checks/AvoidSQLRequestInLoopTest.java new file mode 100644 index 0000000..a982bf0 --- /dev/null +++ b/src/test/java/fr/greencodeinitiative/python/checks/AvoidSQLRequestInLoopTest.java @@ -0,0 +1,12 @@ +package fr.greencodeinitiative.python.checks; + +import org.junit.Test; +import org.sonar.python.checks.utils.PythonCheckVerifier; + +public class AvoidSQLRequestInLoopTest { + @Test + public void test() { + PythonCheckVerifier.verify("src/test/resources/checks/avoidSQLRequestInLoop.py", new AvoidSQLRequestInLoop()); + PythonCheckVerifier.verifyNoIssue("src/test/resources/checks/avoidSQLRequestInLoopNoImports.py", new AvoidSQLRequestInLoop()); + } +} diff --git a/src/test/java/fr/greencodeinitiative/python/checks/AvoidTryCatchFinallyCheckTest.java b/src/test/java/fr/greencodeinitiative/python/checks/AvoidTryCatchFinallyCheckTest.java new file mode 100644 index 0000000..03450d0 --- /dev/null +++ b/src/test/java/fr/greencodeinitiative/python/checks/AvoidTryCatchFinallyCheckTest.java @@ -0,0 +1,12 @@ +package fr.greencodeinitiative.python.checks; + + +import org.junit.Test; +import org.sonar.python.checks.utils.PythonCheckVerifier; + +public class AvoidTryCatchFinallyCheckTest { + @Test + public void test() { + PythonCheckVerifier.verify("src/test/resources/checks/avoidTryCatchFinallyCheck.py", new AvoidTryCatchFinallyCheck()); + } +} diff --git a/src/test/java/fr/greencodeinitiative/python/checks/AvoidUnoptimizedVectorImagesTest.java b/src/test/java/fr/greencodeinitiative/python/checks/AvoidUnoptimizedVectorImagesTest.java new file mode 100644 index 0000000..09a7385 --- /dev/null +++ b/src/test/java/fr/greencodeinitiative/python/checks/AvoidUnoptimizedVectorImagesTest.java @@ -0,0 +1,12 @@ +package fr.greencodeinitiative.python.checks; + +import org.junit.Test; +import org.sonar.python.checks.utils.PythonCheckVerifier; + +public class AvoidUnoptimizedVectorImagesTest { + + @Test + public void test() { + PythonCheckVerifier.verify("src/test/resources/checks/avoidUnoptimizedVectorImages.py", new AvoidUnoptimizedVectorImagesCheck()); + } +} diff --git a/src/test/java/fr/greencodeinitiative/python/checks/DetectUnoptimizedImageFormatTest.java b/src/test/java/fr/greencodeinitiative/python/checks/DetectUnoptimizedImageFormatTest.java new file mode 100644 index 0000000..7c735f5 --- /dev/null +++ b/src/test/java/fr/greencodeinitiative/python/checks/DetectUnoptimizedImageFormatTest.java @@ -0,0 +1,13 @@ +package fr.greencodeinitiative.python.checks; + +import org.junit.Test; +import org.sonar.python.checks.utils.PythonCheckVerifier; + +public class DetectUnoptimizedImageFormatTest { + + @Test + public void test() { + PythonCheckVerifier.verify("src/test/resources/checks/detectUnoptimizedImageFormat.py", new DetectUnoptimizedImageFormat()); + PythonCheckVerifier.verifyNoIssue("src/test/resources/checks/detectUnoptimizedImageFormatCompliant.py", new DetectUnoptimizedImageFormat()); + } +} diff --git a/src/test/java/fr/greencodeinitiative/python/checks/NoFunctionCallWhenDeclaringForLoopTest.java b/src/test/java/fr/greencodeinitiative/python/checks/NoFunctionCallWhenDeclaringForLoopTest.java new file mode 100644 index 0000000..77b1feb --- /dev/null +++ b/src/test/java/fr/greencodeinitiative/python/checks/NoFunctionCallWhenDeclaringForLoopTest.java @@ -0,0 +1,11 @@ +package fr.greencodeinitiative.python.checks; + +import org.junit.Test; +import org.sonar.python.checks.utils.PythonCheckVerifier; + +public class NoFunctionCallWhenDeclaringForLoopTest { + @Test + public void test() { + PythonCheckVerifier.verify("src/test/resources/checks/noFunctionCallWhenDeclaringForLoop.py", new NoFunctionCallWhenDeclaringForLoop()); + } +} diff --git a/src/test/resources/checks/AvoidListComprehensionInIterations.py b/src/test/resources/checks/AvoidListComprehensionInIterations.py new file mode 100644 index 0000000..547eb57 --- /dev/null +++ b/src/test/resources/checks/AvoidListComprehensionInIterations.py @@ -0,0 +1,35 @@ +def non_compliant_example_basic(): + for var in [var2 for var2 in range(1000)]: # Noncompliant {{Use generator comprehension instead of list comprehension in for loop declaration}} + print(var) + +def non_compliant_example_enumerate(): + for idx, var in enumerate([var2 for var2 in range(1000)]): # Noncompliant {{Use generator comprehension instead of list comprehension in for loop declaration}} + print(var) + +def non_compliant_example_zip(): + for var, var_ in zip([var2 for var2 in range(1000)], [var2 for var2 in range(1000)]): # Noncompliant {{Use generator comprehension instead of list comprehension in for loop declaration}} {{Use generator comprehension instead of list comprehension in for loop declaration}} + print(var) + +def non_compliant_example_enumerate_zip(): + for packed_var in enumerate(zip([1, 2, 3], filter(bool, [idx % 2 for idx in range(100)]))): # Noncompliant {{Use generator comprehension instead of list comprehension in for loop declaration}} + print(packed_var) + +def compliant_example_basic_1(): + for var in range(10): + print(var) + +def compliant_example_basic_2(): + for var in (var2 for var2 in range(1000)): + print(var) + +def compliant_example_with_filter(): + for var in filter(lambda x: x > 2, range(100)): + print(var) + +def compliant_example_with_enumerate(): + for idx, var in enumerate(range(1000)): + print(var) + +def compliant_example_with_zip(): + for var, var2 in zip((idx for idx in range(3)), ["a", "b", "c"]): + print(var) diff --git a/src/test/resources/checks/avoidDoubleQuoteCheck.py b/src/test/resources/checks/avoidDoubleQuoteCheck.py new file mode 100644 index 0000000..893f24e --- /dev/null +++ b/src/test/resources/checks/avoidDoubleQuoteCheck.py @@ -0,0 +1,13 @@ +# in variables +firstname = "Andrea" # Noncompliant {{Avoid using quotation mark ("), prefer using simple quote (')}} +lastname = 'Doe' +cars = ["Renault", "Fiat", "Citroen"] # Noncompliant {{Avoid using quotation mark ("), prefer using simple quote (')}} {{Avoid using quotation mark ("), prefer using simple quote (')}} {{Avoid using quotation mark ("), prefer using simple quote (')}} +courses = ['mathematics', 'french', 'IT sciences'] +instruments = ['guitar', "bass", 'drums'] # Noncompliant {{Avoid using quotation mark ("), prefer using simple quote (')}} + +# in functions +def my_function(name, age): + print(name + 'is' + age + ' yo.') + +my_function("Robert", 12) # Noncompliant {{Avoid using quotation mark ("), prefer using simple quote (')}} +my_function('Robert', 12) diff --git a/src/test/resources/checks/avoidFullSQLRequest.py b/src/test/resources/checks/avoidFullSQLRequest.py new file mode 100644 index 0000000..66c6adb --- /dev/null +++ b/src/test/resources/checks/avoidFullSQLRequest.py @@ -0,0 +1,10 @@ +def displayMessage(argument1): + print(argument) + +displayMessage(' sElEcT * fRoM myTable') # Noncompliant {{Don't use the query SELECT * FROM}} +displayMessage(' sElEcT user fRoM myTable') + +requestNonCompiliant = ' SeLeCt * FrOm myTable' # Noncompliant {{Don't use the query SELECT * FROM}} +requestCompiliant = ' SeLeCt user FrOm myTable' +displayMessage(requestNonCompiliant) +displayMessage(requestCompiliant) diff --git a/src/test/resources/checks/avoidGettersAndSetters.py b/src/test/resources/checks/avoidGettersAndSetters.py new file mode 100644 index 0000000..538e79a --- /dev/null +++ b/src/test/resources/checks/avoidGettersAndSetters.py @@ -0,0 +1,26 @@ +from datetime import date + +class Client(): + + def __init__(self, age, weight): + self.age = age + self.weight = weight + + def set_age(self, age): # Noncompliant {{Avoid creating getter and setter methods in classes}} + self.age = age + + def set_age(self, age2): # Noncompliant {{Avoid creating getter and setter methods in classes}} + self.age = age2 + + def get_age_in_five_years(self): + a = Client() + return a.age + + def get_age(self): # Noncompliant {{Avoid creating getter and setter methods in classes}} + return self.age + + def is_major(self): + return self.age >= 18 + + def get_weight(self): # Noncompliant {{Avoid creating getter and setter methods in classes}} + return self.weight diff --git a/src/test/resources/checks/avoidGlobalVariableInFunction.py b/src/test/resources/checks/avoidGlobalVariableInFunction.py new file mode 100644 index 0000000..9b77dfa --- /dev/null +++ b/src/test/resources/checks/avoidGlobalVariableInFunction.py @@ -0,0 +1,43 @@ +global_var = 'global' + +def print_global_var_details(): + print(len(global_var)) # Noncompliant + print('Global var : ', global_var) # Noncompliant + print('Global var : ' + global_var) # Noncompliant + for c in global_var: # Noncompliant + print(c) + if len(global_var) > 0: # Noncompliant + print('global_var len positive') + elif 0 < len(global_var): # Noncompliant + print('global_var len negative') + else: + print('global_var len = 0') + + try: + print(global_var) # Noncompliant + except: + print(global_var) # Noncompliant + else: + print(global_var) # Noncompliant + finally: + print(global_var) # Noncompliant + + assert len(global_var) > 0, 'Failed' # Noncompliant + assert len('test') > 0, 'Failed : ' + global_var # Noncompliant + test = '' + test += global_var # Noncompliant + test = {'test': global_var, 'global_var': 1 } # Noncompliant + +# Compliant +def print_var_length(local_var = global_var): + global_var = 'local' # Here it create a local var and do not use the global var + global_var: str = 'local' # Here it create a local var and do not use the global var + global_var += 'local' # Here it create a local var and do not use the global var + global_var = 'local' if True else 'global' # Here it create a local var and do not use the global var + print(len(global_var)) # Compliant for the use, but not for the name of the var + print(len(local_var)) + for global_var in local_var: # Compliant but not for the name + print(global_var) + +print_global_var_details() +print_var_length(global_var) diff --git a/src/test/resources/checks/avoidSQLRequestInLoop.py b/src/test/resources/checks/avoidSQLRequestInLoop.py new file mode 100644 index 0000000..3940881 --- /dev/null +++ b/src/test/resources/checks/avoidSQLRequestInLoop.py @@ -0,0 +1,42 @@ +import mysql.connector +import psycopg2 +import pyodbc +import sqlite3 + +def mysql_loop(): + connection = mysql.connector.connect(database='local') + cursor = connection.cursor() + results = [] + for id in range(5): + results.append(cursor.execute("SELECT name FROM user WHERE id = ?", (id)).fetchone()) # Noncompliant {{Avoid performing SQL queries within a loop}} + connection.close() + return results + +def psycopg2_loop(): + connection = psycopg2.connect(database='local') + cursor = connection.cursor() + results = [] + id = 0 + while id <= 5: + results.append(cursor.execute("SELECT name FROM user WHERE id = ?", (id)).fetchone()) # Noncompliant {{Avoid performing SQL queries within a loop}} + id += 1 + connection.close() + return results + +def pyodbc_loop(): + connection = pyodbc.connect('DRIVER={ODBC Driver 17 for SQL Server};SERVER=localhost;DATABASE=local') + cursor = connection.cursor() + results = [] + for id in range(5): + results.append(cursor.execute("SELECT name FROM user WHERE id = ?", (id)).fetchone()) # Noncompliant {{Avoid performing SQL queries within a loop}} + connection.close() + return results + +def sqlite3_loop(): + connection = sqlite3.connect("local.db") + cursor = connection.cursor() + results = [] + for id in range(5): + results.append(cursor.execute("SELECT name FROM user WHERE id = ?", (id)).fetchone()) # Noncompliant {{Avoid performing SQL queries within a loop}} + connection.close() + return results diff --git a/src/test/resources/checks/avoidSQLRequestInLoopCheck.py b/src/test/resources/checks/avoidSQLRequestInLoopCheck.py new file mode 100644 index 0000000..7f98cd5 --- /dev/null +++ b/src/test/resources/checks/avoidSQLRequestInLoopCheck.py @@ -0,0 +1,83 @@ +import mysql.connector + + +class AvoidSQLRequestInLoopCheck: + maxrows = 20 + + def testWithNoLoop(self): + try : + db = mysql.connector.connect(option_files='my.conf', use_pure=True) + cursor = db.cursor(dictionary=True) + + cursor.execute('SELECT id, name FROM users LIMIT %(limit)s', {'limit': self.maxrows}) + for row in cursor.fetchall(): + print("{}: {}".format(row['id'], row['name'])) + + cursor.close() + db.close() + except mysql.connector.Error as err: + print("Got an exception: {}".format(err)) + db.close() + + def testWithForLoop(self): + try: + db = mysql.connector.connect(option_files='my.conf', use_pure=True) + cursor = db.cursor(dictionary=True) + + for i in range(0, self.maxrows): + cursor.execute("SELECT id, name FROM users WHERE id = %(id)s", {'id': i+1}) #Noncompliant + for row in cursor.fetchall(): + print("{}: {}".format(row['id'], row['name'])) + + cursor.close() + db.close() + except mysql.connector.Error as err: + print("Got an exception: {}".format(err)) + db.close() + + def testWithWhileLoop(self): + try: + db = mysql.connector.connect(option_files='my.conf', use_pure=True) + cursor = db.cursor(dictionary=True) + + i = 0 + while i < self.maxrows: + cursor.execute("SELECT id, name FROM users WHERE id = %(id)s", {'id': i+1}) #Noncompliant + for row in cursor.fetchall(): + print("name: {}".format(row['name'])) + i += 1 + + cursor.close() + db.close() + except mysql.connector.Error as err: + print("Got an exception: {}".format(err)) + db.close() + + def testWithWhileLoopUpdate(self): + try: + db = mysql.connector.connect(option_files='my.conf', use_pure=True) + cursor=db.cursor() + + i = 0 + while i < self.maxrows: + cursor.execute('UPDATE users set name=%(name)s where id=%(id)s', {'name': "anonymous", 'id': i+1}) + i+=1 + db.commit() + + cursor.close() + db.close() + except mysql.connector.Error as err: + print("Got an exception: {}".format(err)) + db.close() + +if __name__ == '__main__': + test = AvoidSQLRequestInLoopCheck() + + print("testWithNoLoop") + test.testWithNoLoop() + print("testWithForLoop") + test.testWithForLoop() + print("testWithWhileLoop") + test.testWithWhileLoop() + print("testWithWhileLoopUpdate") + test.testWithWhileLoopUpdate() diff --git a/src/test/resources/checks/avoidSQLRequestInLoopNoImports.py b/src/test/resources/checks/avoidSQLRequestInLoopNoImports.py new file mode 100644 index 0000000..fe85138 --- /dev/null +++ b/src/test/resources/checks/avoidSQLRequestInLoopNoImports.py @@ -0,0 +1,26 @@ +def mysql_loop(): + connection = mysql.connector.connect(database='local') + cursor = connection.cursor() + results = [] + for id in range(5): + results.append(cursor.execute("SELECT name FROM user WHERE id = ?", (id)).fetchone()) # OK + connection.close() + return results + +def pyodbc_loop(): + connection = pyodbc.connect('DRIVER={ODBC Driver 17 for SQL Server};SERVER=localhost;DATABASE=local') + cursor = connection.cursor() + results = [] + for id in range(5): + results.append(cursor.execute("SELECT name FROM user WHERE id = ?", (id)).fetchone()) # OK + connection.close() + return results + +def sqlite3_loop(): + connection = sqlite3.connect("local.db") + cursor = connection.cursor() + results = [] + for id in range(5): + results.append(cursor.execute("SELECT name FROM user WHERE id = ?", (id)).fetchone()) # OK + connection.close() + return results diff --git a/src/test/resources/checks/avoidTryCatchFinallyCheck.py b/src/test/resources/checks/avoidTryCatchFinallyCheck.py new file mode 100644 index 0000000..cbd081e --- /dev/null +++ b/src/test/resources/checks/avoidTryCatchFinallyCheck.py @@ -0,0 +1,29 @@ +import os.path + +path = 'hello.txt' + + +def my_function(): + x=0 + + try: # Noncompliant {{Avoid the use of try-catch}} + print(x) + except: + print("Something went wrong") + finally: + print("The 'try except' is finished") + +def foo(): + try: # Noncompliant {{Avoid the use of try-catch}} + f = open(path) + print(f.read()) + except: + print('No such file '+path) + finally: + f.close() + +def boo(): + if os.path.isfile(path): + fh = open(path, 'r') + print(fh.read()) + fh.close diff --git a/src/test/resources/checks/avoidUnoptimizedVectorImages.py b/src/test/resources/checks/avoidUnoptimizedVectorImages.py new file mode 100644 index 0000000..9893da5 --- /dev/null +++ b/src/test/resources/checks/avoidUnoptimizedVectorImages.py @@ -0,0 +1,5 @@ +image0 = """""" +image1 = """""" # Noncompliant {{Avoid using unoptimized vector images}} +image2 = "" # Noncompliant {{Avoid using unoptimized vector images}} +image3 = "......" # Noncompliant {{Avoid using unoptimized vector images}} +image4 = "" # Noncompliant {{Avoid using unoptimized vector images}} diff --git a/src/test/resources/checks/detectUnoptimizedImageFormat.py b/src/test/resources/checks/detectUnoptimizedImageFormat.py new file mode 100644 index 0000000..37ddac2 --- /dev/null +++ b/src/test/resources/checks/detectUnoptimizedImageFormat.py @@ -0,0 +1,36 @@ + +def testImage(image) : + return "path/to/" + image + + +def testImageFormat2() : + + img_bmp = "test/image.bmp" # Noncompliant {{If possible, the utilisation of svg image format (or html tag) is recommended over other image format.}} + img_ico = "image.ico" # Noncompliant {{If possible, the utilisation of svg image format (or html tag) is recommended over other image format.}} + img_tiff = "test/path/to/image.tiff" # Noncompliant {{If possible, the utilisation of svg image format (or html tag) is recommended over other image format.}} + img_webp = "test/path/to/" + "image.webp" # Noncompliant {{If possible, the utilisation of svg image format (or html tag) is recommended over other image format.}} + img_jpg = "image.jpg" # Noncompliant {{If possible, the utilisation of svg image format (or html tag) is recommended over other image format.}} + img_jpeg = "image.jpeg" # Noncompliant {{If possible, the utilisation of svg image format (or html tag) is recommended over other image format.}} + img_jfif = "image.jfif" # Noncompliant {{If possible, the utilisation of svg image format (or html tag) is recommended over other image format.}} + img_pjpeg = "image.pjpeg" # Noncompliant {{If possible, the utilisation of svg image format (or html tag) is recommended over other image format.}} + img_pjp = "image.pjp" # Noncompliant {{If possible, the utilisation of svg image format (or html tag) is recommended over other image format.}} + img_gif = "image.gif" # Noncompliant {{If possible, the utilisation of svg image format (or html tag) is recommended over other image format.}} + img_avif = "image.avif" # Noncompliant {{If possible, the utilisation of svg image format (or html tag) is recommended over other image format.}} + img_apng = "image.apng" # Noncompliant {{If possible, the utilisation of svg image format (or html tag) is recommended over other image format.}} + + image_format = testImage("image.jpg") # Noncompliant {{If possible, the utilisation of svg image format (or html tag) is recommended over other image format.}} + + return ('' # Noncompliant {{If possible, the utilisation of svg image format (or html tag) is recommended over other image format.}} + + '' # Noncompliant {{If possible, the utilisation of svg image format (or html tag) is recommended over other image format.}} + + '' # Noncompliant {{If possible, the utilisation of svg image format (or html tag) is recommended over other image format.}} + + '' # Noncompliant {{If possible, the utilisation of svg image format (or html tag) is recommended over other image format.}} + + '' # Noncompliant {{If possible, the utilisation of svg image format (or html tag) is recommended over other image format.}} + + '' # Noncompliant {{If possible, the utilisation of svg image format (or html tag) is recommended over other image format.}} + + '' # Noncompliant {{If possible, the utilisation of svg image format (or html tag) is recommended over other image format.}} + + '' # Noncompliant {{If possible, the utilisation of svg image format (or html tag) is recommended over other image format.}} + + '' # Noncompliant {{If possible, the utilisation of svg image format (or html tag) is recommended over other image format.}} + + '' # Noncompliant {{If possible, the utilisation of svg image format (or html tag) is recommended over other image format.}} + + '' # Noncompliant {{If possible, the utilisation of svg image format (or html tag) is recommended over other image format.}} + + '' # Noncompliant {{If possible, the utilisation of svg image format (or html tag) is recommended over other image format.}} + + '' # Noncompliant {{If possible, the utilisation of svg image format (or html tag) is recommended over other image format.}} + + '' ) diff --git a/src/test/resources/checks/detectUnoptimizedImageFormatCompliant.py b/src/test/resources/checks/detectUnoptimizedImageFormatCompliant.py new file mode 100644 index 0000000..205f125 --- /dev/null +++ b/src/test/resources/checks/detectUnoptimizedImageFormatCompliant.py @@ -0,0 +1,17 @@ + +def testImage(image) : + return "path/to/" + image + + +def testImageFormat2() : + + img_svg = "test/image.svg" # Compliant + + image_format = testImage("image.svg") # Compliant + + image_svg_html = ('' + # Compliant + '' + + '') + + return ('' # Compliant + + '' ) diff --git a/src/test/resources/checks/init_dbtest.sql b/src/test/resources/checks/init_dbtest.sql new file mode 100644 index 0000000..9a7a0a5 --- /dev/null +++ b/src/test/resources/checks/init_dbtest.sql @@ -0,0 +1,34 @@ +DROP TABLE IF EXISTS users; + +CREATE TABLE users ( + id INT NOT NULL AUTO_INCREMENT, + name VARCHAR(255), + PRIMARY KEY (id) +); + +INSERT INTO users(name) VALUES('a'); +INSERT INTO users(name) VALUES('b'); +INSERT INTO users(name) VALUES('c'); +INSERT INTO users(name) VALUES('d'); +INSERT INTO users(name) VALUES('e'); +INSERT INTO users(name) VALUES('f'); +INSERT INTO users(name) VALUES('g'); +INSERT INTO users(name) VALUES('h'); +INSERT INTO users(name) VALUES('i'); +INSERT INTO users(name) VALUES('j'); +INSERT INTO users(name) VALUES('k'); +INSERT INTO users(name) VALUES('l'); +INSERT INTO users(name) VALUES('m'); +INSERT INTO users(name) VALUES('n'); +INSERT INTO users(name) VALUES('o'); +INSERT INTO users(name) VALUES('p'); +INSERT INTO users(name) VALUES('q'); +INSERT INTO users(name) VALUES('r'); +INSERT INTO users(name) VALUES('s'); +INSERT INTO users(name) VALUES('t'); +INSERT INTO users(name) VALUES('u'); +INSERT INTO users(name) VALUES('v'); +INSERT INTO users(name) VALUES('w'); +INSERT INTO users(name) VALUES('x'); +INSERT INTO users(name) VALUES('y'); +INSERT INTO users(name) VALUES('z'); diff --git a/src/test/resources/checks/my.conf.sample b/src/test/resources/checks/my.conf.sample new file mode 100644 index 0000000..e10dc23 --- /dev/null +++ b/src/test/resources/checks/my.conf.sample @@ -0,0 +1,5 @@ +[client] +host = localhost +user = dbtest +password = dbtest +database = dbtest diff --git a/src/test/resources/checks/noFunctionCallWhenDeclaringForLoop.py b/src/test/resources/checks/noFunctionCallWhenDeclaringForLoop.py new file mode 100644 index 0000000..97cb01e --- /dev/null +++ b/src/test/resources/checks/noFunctionCallWhenDeclaringForLoop.py @@ -0,0 +1,9 @@ +def my_function(): + return 6 + +for i in my_function(): # Noncompliant {{Do not call a function when declaring a for-type loop}} + print("Test") + my_function() + pass + +my_function() diff --git a/tool_build.sh b/tool_build.sh new file mode 100755 index 0000000..c6f1fba --- /dev/null +++ b/tool_build.sh @@ -0,0 +1,4 @@ +#!/usr/bin/env sh + +rm -rf ./lib/*.jar +mvn clean package -DskipTests diff --git a/tool_compile.sh b/tool_compile.sh new file mode 100755 index 0000000..3d3e0d8 --- /dev/null +++ b/tool_compile.sh @@ -0,0 +1,3 @@ +#!/usr/bin/env sh + +mvn clean compile diff --git a/tool_docker-clean.sh b/tool_docker-clean.sh new file mode 100755 index 0000000..2eadb2e --- /dev/null +++ b/tool_docker-clean.sh @@ -0,0 +1,3 @@ +#!/usr/bin/env sh + +docker-compose down --volumes diff --git a/tool_docker-init.sh b/tool_docker-init.sh new file mode 100755 index 0000000..ffaa40b --- /dev/null +++ b/tool_docker-init.sh @@ -0,0 +1,3 @@ +#!/usr/bin/env sh + +docker-compose up --build -d diff --git a/tool_docker-logs.sh b/tool_docker-logs.sh new file mode 100755 index 0000000..2b082e9 --- /dev/null +++ b/tool_docker-logs.sh @@ -0,0 +1,3 @@ +#!/usr/bin/env sh + +docker-compose logs -f diff --git a/tool_release_1_prepare.sh b/tool_release_1_prepare.sh new file mode 100755 index 0000000..e87b946 --- /dev/null +++ b/tool_release_1_prepare.sh @@ -0,0 +1,13 @@ +#!/usr/bin/env sh + +### +# PURPOSE : use maven plugin release to prepare locally next release and next SNAPSHOT +### + +# creation of 2 commits with release and next SNAPSHOT +mvn release:prepare -B -ff -DpushChanges=false -DtagNameFormat=@{project.version} + +sleep 2 + +# clean temporary files +mvn release:clean diff --git a/tool_release_2_branch.sh b/tool_release_2_branch.sh new file mode 100755 index 0000000..ca2e822 --- /dev/null +++ b/tool_release_2_branch.sh @@ -0,0 +1,13 @@ +#!/usr/bin/env sh + +### +# PURPOSE : create an push an new branch with commits previously prepared with `tool_release_1_prepare.sh` +### + +# checkout released tag and creation of branch to push (becasue of main protection) +LAST_TAG=$(git tag --sort=-version:refname | head -n 1) +BRANCH_NAME=$(echo "release_${LAST_TAG}") +git checkout -b ${BRANCH_NAME} + +# push branch associated to new tag release +git push --set-upstream origin ${BRANCH_NAME} diff --git a/tool_start.sh b/tool_start.sh new file mode 100755 index 0000000..20f793f --- /dev/null +++ b/tool_start.sh @@ -0,0 +1,3 @@ +#!/usr/bin/env sh + +docker-compose start diff --git a/tool_start_withtoken.sh b/tool_start_withtoken.sh new file mode 100755 index 0000000..2861a22 --- /dev/null +++ b/tool_start_withtoken.sh @@ -0,0 +1,4 @@ +#!/usr/bin/env sh + +# private TOKEN to change once generated in your local SonarQube +TOKEN=MY_TOKEN_TO_REPLACE docker-compose up --build -d diff --git a/tool_stop.sh b/tool_stop.sh new file mode 100755 index 0000000..41630e6 --- /dev/null +++ b/tool_stop.sh @@ -0,0 +1,3 @@ +#!/usr/bin/env sh + +docker-compose stop