SONARPY-3706 Invert -DskipTypeshed mvn flag (#815)

GitOrigin-RevId: a9a29df1f39ff3478490238e1cdf85682be4c03e

Author: Seppli11

.cirrus/analyze.sh

@@ -3,6 +3,7 @@ function run_maven {
   # No need for Maven phase "install" as the generated JAR files do not need to be installed
   # in Maven local repository. Phase "verify" is enough.
   mvn verify org.sonarsource.scanner.maven:sonar-maven-plugin:sonar \
+    -DgenerateTypeshedStubs \
     -Pcoverage \
     -Dmaven.test.redirectTestOutputToFile=false \
     -Dsonar.projectName="Python" \
@@ -60,6 +61,7 @@ elif [ "$PULL_REQUEST" != "false" ]; then
 elif [[ "$GITHUB_BRANCH" == "dogfood-on-"* ]] && [ "$PULL_REQUEST" == "false" ]; then
   echo '======= Build dogfood branch'
   mvn verify \
+   -DgenerateTypeshedStubs \
    -DfailStubGenerationFast=true \
    -Dskip.its=true \
    --batch-mode \
@@ -74,6 +76,7 @@ else
   # in Maven local repository. Phase "verify" is enough.
 
   mvn verify \
+      -DgenerateTypeshedStubs \
       -Dmaven.test.redirectTestOutputToFile=false \
       --batch-mode \
        --errors \

.github-commons/actions/analyze/action.yml

@@ -16,7 +16,7 @@ runs:
       with:
         maven-args: >-
           -Dsonar.organization=sonarsource -Dsonar.projectKey=${{ inputs.sonar-project-key }}
-          -Dsonar.analysisCache.enabled=true -Dsonar.sca.recursiveManifestSearch=true -DfailStubGenerationFast=true -Dskip.its=true
+          -Dsonar.analysisCache.enabled=true -Dsonar.sca.recursiveManifestSearch=true -DgenerateTypeshedStubs -DfailStubGenerationFast=true -Dskip.its=true
         deploy: false
         sonar-platform: ${{ inputs.sonarqube-instance }}
         scanner-java-opts: '-Xmx1G'

.github/actions/build-sonar-python/action.yml

@@ -11,7 +11,7 @@ runs:
       uses: SonarSource/ci-github-actions/build-maven@v1
       id: build
       with:
-        maven-args: '-DskipTests=true -Dsonar.skip=true -P-typeshed_serializer'
+        maven-args: '-DskipTests=true -Dsonar.skip=true'
         deploy-pull-request: true
         sonar-platform: none
         mixed-privacy: true

.github/instructions/rules-testing.instructions.md

@@ -4,7 +4,7 @@ applyTo: "**/*checks*/**/*.java"
 Each rule implementation needs to be well tested.
 To do so, we have powerful utilities in `PythonCheckVerifier` that allows for verification.
 
-You can run the test for a given class with the shell command `mvn verify -DskipTypeshed -DskipObfuscation -f"python-checks/pom.xml" -Dtest=$YOUR_TEST_CLASS`
+You can run the test for a given class with the shell command `mvn verify -DskipObfuscation -f"python-checks/pom.xml" -Dtest=$YOUR_TEST_CLASS`
 Replace the $YOUR_TEST_CLASS by the name of the test class, usually of the form SleepZeroInAsyncCheckTest for the SleepZeroInAsyncCheck rule.
 
 Look carefully at the terminal output, and make sure the test was successful.

.github/instructions/tdd-planning-execution-refactoring.instructions.md

@@ -121,7 +121,7 @@ void test() {
 
 ### Test Execution Command
 ```bash
-mvn verify -DskipTypeshed -DskipObfuscation -f python-checks/pom.xml -Dtest=YourTestClass
+mvn verify -DskipObfuscation -f python-checks/pom.xml -Dtest=YourTestClass
 ```
 
 ## Key Success Practices

README.md

@@ -20,10 +20,10 @@ Sonar's [integrated code quality and code security](https://www.sonarsource.com/
 
 The easiest way to build the Project is by running:
 
-`mvn clean install -DskipTypeshed -P-private`
+`mvn clean install -P-private`
 
 It builds only Java Maven modules, runs tests, and installs jar locally.
-The Python interpreter is not required in that case.
+The Python interpreter is not required in that case. Typeshed stub generation is skipped by default.
 
 ### Full build
 
@@ -46,10 +46,27 @@ To execute the full build just run:
 
 `mvn clean install -P-private`
 
-The full build executes [Typeshed](https://github.com/python/typeshed) serializer script. 
-It generates protobuf messages for Typeshed symbols (for standard Python API) and our customs symbols 
+The full build executes [Typeshed](https://github.com/python/typeshed) serializer script.
+It generates protobuf messages for Typeshed symbols (for standard Python API) and our customs symbols
 (for Python libraries, e.g. [AWS CDK](https://docs.aws.amazon.com/cdk/v2/guide/work-with-cdk-python.html)).
-This helps with type inference and providing better rules.  
+This helps with type inference and providing better rules.
+
+### Typeshed Stub Generation
+
+By default, Maven builds skip typeshed stub generation for faster build times. The stubs are pre-generated and committed to the repository.
+
+To regenerate typeshed stubs, use the provided Docker script:
+```
+cd python-frontend/typeshed_serializer
+./build-with-docker.sh
+```
+
+Alternatively, you can generate stubs during a Maven build by adding the `-DgenerateTypeshedStubs` flag:
+```
+mvn clean install -DgenerateTypeshedStubs
+```
+
+Note: Stub generation requires Python 3.9+ and tox to be installed.
 
 ## How to contribute
 

python-frontend/pom.xml

@@ -163,7 +163,7 @@
       <activation>
         <property>
           <name>
-            !skipTypeshed
+            generateTypeshedStubs
           </name>
         </property>
       </activation>