Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SONARPY-2457 Collect data for the Python version #2252

Merged
merged 2 commits into from
Dec 17, 2024
Merged

SONARPY-2457 Collect data for the Python version #2252

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f12c2bf
SONARPY-2457 Collect data for the Python version
ghislainpiot Dec 16, 2024
6dee94c
Address review comments
ghislainpiot Dec 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions sonar-python-plugin/src/main/java/org/sonar/plugins/python/IPynbSensor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ private List<PythonInputFile> parseNotebooks(List<PythonInputFile> pythonFiles,

for (PythonInputFile inputFile : pythonFiles) {
try {
sensorTelemetryStorage.updateMetric(TelemetryMetricKey.NOTEBOOK_PRESENT_KEY, "1");
sensorTelemetryStorage.updateMetric(TelemetryMetricKey.NOTEBOOK_PRESENT_KEY, true);
var result = IpynbNotebookParser.parseNotebook(inputFile);
result.ifPresent(generatedIPythonFiles::add);
} catch (Exception e) {
Expand All @@ -114,7 +114,7 @@ private List<PythonInputFile> parseNotebooks(List<PythonInputFile> pythonFiles,
}
}

sensorTelemetryStorage.updateMetric(TelemetryMetricKey.NOTEBOOK_EXCEPTION_KEY, String.valueOf(numberOfExceptions));
sensorTelemetryStorage.updateMetric(TelemetryMetricKey.NOTEBOOK_EXCEPTION_KEY, numberOfExceptions);
return generatedIPythonFiles;
}

Expand Down
15 changes: 15 additions & 0 deletions sonar-python-plugin/src/main/java/org/sonar/plugins/python/PythonSensor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,8 @@ public final class PythonSensor implements Sensor {
static final String UNSET_VERSION_WARNING = "Your code is analyzed as compatible with all Python 3 versions by default." +
" You can get a more precise analysis by setting the exact Python version in your configuration via the parameter \"sonar.python.version\"";

private final SensorTelemetryStorage sensorTelemetryStorage;

/**
* Constructor to be used by pico if neither PythonCustomRuleRepository nor PythonIndexer are to be found and injected.
*/
Expand Down Expand Up @@ -100,6 +102,7 @@ public PythonSensor(FileLinesContextFactory fileLinesContextFactory, CheckFactor
this.indexer = indexer;
this.sonarLintCache = sonarLintCache;
this.analysisWarnings = analysisWarnings;
this.sensorTelemetryStorage = new SensorTelemetryStorage();
}

@Override
Expand All @@ -121,15 +124,27 @@ public void execute(SensorContext context) {
if (pythonVersionParameter.length != 0){
ProjectPythonVersion.setCurrentVersions(PythonVersionUtils.fromStringArray(pythonVersionParameter));
}
updatePythonVersionTelemetry(context, pythonVersionParameter);
CacheContext cacheContext = CacheContextImpl.of(context);
PythonIndexer pythonIndexer = this.indexer != null ? this.indexer : new SonarQubePythonIndexer(pythonFiles, cacheContext, context);
pythonIndexer.setSonarLintCache(sonarLintCache);
TypeShed.setProjectLevelSymbolTable(pythonIndexer.projectLevelSymbolTable());
PythonScanner scanner = new PythonScanner(context, checks, fileLinesContextFactory, noSonarFilter, PythonParser.create(), pythonIndexer);
scanner.execute(pythonFiles, context);
sensorTelemetryStorage.send(context);
durationReport.stop();
}

private void updatePythonVersionTelemetry(SensorContext context, String[] pythonVersionParameter) {
if (context.runtime().getProduct() == SonarProduct.SONARLINT) {
return;
}
sensorTelemetryStorage.updateMetric(TelemetryMetricKey.PYTHON_VERSION_SET_KEY, pythonVersionParameter.length != 0);
if (pythonVersionParameter.length != 0) {
sensorTelemetryStorage.updateMetric(TelemetryMetricKey.PYTHON_VERSION_KEY, String.join(",", pythonVersionParameter));
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So that means we can set more than just booleans for the telemetry?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, CFamily is sending strings.

}
}

private static List<PythonInputFile> getInputFiles(SensorContext context) {
FilePredicates p = context.fileSystem().predicates();
Iterable<InputFile> it = context.fileSystem().inputFiles(p.and(p.hasLanguage(Python.KEY)));
Expand Down
8 changes: 8 additions & 0 deletions sonar-python-plugin/src/main/java/org/sonar/plugins/python/SensorTelemetryStorage.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,4 +55,12 @@ public void updateMetric(TelemetryMetricKey key, int value) {
data.put(key, String.valueOf(value));
}

public void updateMetric(TelemetryMetricKey key, boolean value) {
data.put(key, boolToString(value));
}

private static String boolToString(boolean value) {
return value ? "1" : "0";
}

}
4 changes: 3 additions & 1 deletion sonar-python-plugin/src/main/java/org/sonar/plugins/python/TelemetryMetricKey.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,9 @@ public enum TelemetryMetricKey {
NOTEBOOK_PRESENT_KEY("python.notebook.present"),
NOTEBOOK_TOTAL_KEY("python.notebook.total"),
NOTEBOOK_RECOGNITION_ERROR_KEY("python.notebook.recognition_error"),
NOTEBOOK_EXCEPTION_KEY("python.notebook.exceptions");
NOTEBOOK_EXCEPTION_KEY("python.notebook.exceptions"),
PYTHON_VERSION_SET_KEY("python.version.set"),
PYTHON_VERSION_KEY("python.version");

private final String key;

Expand Down
30 changes: 30 additions & 0 deletions sonar-python-plugin/src/test/java/org/sonar/plugins/python/PythonSensorTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1408,6 +1408,36 @@ void test_scanner_isNotebook() {
assertThat(PythonScanner.isNotebook(notebookPythonFile)).isTrue();
}

@Test
void send_telemetry_with_version() {
activeRules = new ActiveRulesBuilder()
.addRule(new NewActiveRule.Builder()
.setRuleKey(RuleKey.of(CheckList.REPOSITORY_KEY, "S930"))
.build())
.build();

context.setSettings(new MapSettings().setProperty("sonar.python.version", "3.10,3.13"));
var contextSpy = spy(context);
PythonSensor sensor = sensor();
sensor.execute(contextSpy);
verify(contextSpy, times(1)).addTelemetryProperty(TelemetryMetricKey.PYTHON_VERSION_KEY.key(), "3.10,3.13");
verify(contextSpy, times(1)).addTelemetryProperty(TelemetryMetricKey.PYTHON_VERSION_SET_KEY.key(), "1");
}

@Test
void send_telemetry_no_version() {
activeRules = new ActiveRulesBuilder()
.addRule(new NewActiveRule.Builder()
.setRuleKey(RuleKey.of(CheckList.REPOSITORY_KEY, "S930"))
.build())
.build();

PythonSensor sensor = sensor();
var contextSpy = spy(context);
sensor.execute(contextSpy);
verify(contextSpy, times(1)).addTelemetryProperty(TelemetryMetricKey.PYTHON_VERSION_SET_KEY.key(), "0");
}

private com.sonar.sslr.api.Token passToken(URI uri) {
return com.sonar.sslr.api.Token.builder()
.setType(PythonKeyword.PASS)
Expand Down
Loading