SONAR-23738 Portfolio and Subportfolio selection mode telemetry

11 files changed, 339 insertions, 1 deletions

diff --git a/server/sonar-db-dao/src/it/java/org/sonar/db/portfolio/PortfolioDaoIT.java b/server/sonar-db-dao/src/it/java/org/sonar/db/portfolio/PortfolioDaoIT.java
index 3ba8db0adde..22a272348a6 100644
--- a/server/sonar-db-dao/src/it/java/org/sonar/db/portfolio/PortfolioDaoIT.java
+++ b/server/sonar-db-dao/src/it/java/org/sonar/db/portfolio/PortfolioDaoIT.java
@@ -21,6 +21,7 @@ package org.sonar.db.portfolio;
 
 import java.util.Arrays;
 import java.util.List;
+import java.util.Map;
 import java.util.Set;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.RegisterExtension;
@@ -48,6 +49,10 @@ import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.times;
 import static org.mockito.Mockito.verify;
+import static org.sonar.db.portfolio.PortfolioDto.SelectionMode.MANUAL;
+import static org.sonar.db.portfolio.PortfolioDto.SelectionMode.REGEXP;
+import static org.sonar.db.portfolio.PortfolioDto.SelectionMode.REST;
+import static org.sonar.db.portfolio.PortfolioDto.SelectionMode.TAGS;
 
 class PortfolioDaoIT {
   private final System2 system2 = new AlwaysIncreasingSystem2(1L, 1);
@@ -740,6 +745,29 @@ class PortfolioDaoIT {
     assertThat(db.countRowsOfTable(session, "portfolio_proj_branches")).isZero();
   }
 
+  @Test
+  void countPortfoliosByMode_shouldReturnCorrectData() {
+    PortfolioDto portfolio1 = ComponentTesting.newPortfolioDto("uuid1", "ptf1", "Portfolio 1", null)
+      .setSelectionMode(REGEXP);
+    PortfolioDto subPortfolio1 = ComponentTesting.newPortfolioDto("sub_uuid11", "sub_ptf1", "SubPortfolio 1", portfolio1)
+      .setSelectionMode(MANUAL);
+    PortfolioDto subSubPortfolio1 = ComponentTesting.newPortfolioDto("sub_uuid12", "sub_sub_ptf1", "SubSubPortfolio 1", portfolio1)
+      .setSelectionMode(REST);
+    PortfolioDto portfolio2 = ComponentTesting.newPortfolioDto("uuid2", "ptf2", "Portfolio 2", null)
+      .setSelectionMode(REGEXP);
+    PortfolioDto subPortfolio2 = ComponentTesting.newPortfolioDto("sub_uuid21", "sub_ptd2", "SubPortfolio 2", portfolio2)
+      .setSelectionMode(TAGS);
+    Arrays.asList(portfolio1, subPortfolio1, subSubPortfolio1, portfolio2, subPortfolio2)
+      .forEach(portfolio -> portfolioDao.insertWithAudit(db.getSession(), portfolio));
+
+    Map<String, Integer> expectedForRoot = Map.of(REGEXP.name(), 2);
+    assertThat(portfolioDao.countPortfoliosByMode(db.getSession()))
+      .containsExactlyInAnyOrderEntriesOf(expectedForRoot);
+    Map<String, Integer> expectedForSub = Map.of(MANUAL.name(), 1, REST.name(), 1, TAGS.name(), 1);
+    assertThat(portfolioDao.countSubportfoliosByMode(db.getSession()))
+      .containsExactlyInAnyOrderEntriesOf(expectedForSub);
+  }
+
   private PortfolioDto addPortfolio(PortfolioDto parent) {
     return addPortfolio(parent, uuidFactory.create());
   }
diff --git a/server/sonar-db-dao/src/main/java/org/sonar/db/portfolio/ModeCount.java b/server/sonar-db-dao/src/main/java/org/sonar/db/portfolio/ModeCount.java
new file mode 100644
index 00000000000..a05799c6817
--- /dev/null
+++ b/server/sonar-db-dao/src/main/java/org/sonar/db/portfolio/ModeCount.java
@@ -0,0 +1,41 @@
+/*
+ * SonarQube
+ * Copyright (C) 2009-2024 SonarSource SA
+ * mailto:info AT sonarsource DOT com
+ *
+ * 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 Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ */
+package org.sonar.db.portfolio;
+
+public class ModeCount {
+  private String selectionMode;
+  private int count;
+
+  public ModeCount() {
+  }
+
+  public ModeCount(String selectionMode, int count) {
+    this.selectionMode = selectionMode;
+    this.count = count;
+  }
+
+  public String getSelectionMode() {
+    return selectionMode;
+  }
+
+  public int getCount() {
+    return count;
+  }
+}
diff --git a/server/sonar-db-dao/src/main/java/org/sonar/db/portfolio/PortfolioDao.java b/server/sonar-db-dao/src/main/java/org/sonar/db/portfolio/PortfolioDao.java
index 25c49676cf8..071f55344f7 100644
--- a/server/sonar-db-dao/src/main/java/org/sonar/db/portfolio/PortfolioDao.java
+++ b/server/sonar-db-dao/src/main/java/org/sonar/db/portfolio/PortfolioDao.java
@@ -20,16 +20,18 @@
 package org.sonar.db.portfolio;
 
 import java.util.List;
+import java.util.Map;
 import java.util.Optional;
 import java.util.Set;
+import java.util.stream.Collectors;
 import javax.annotation.CheckForNull;
-import org.sonar.db.component.ComponentQualifiers;
 import org.sonar.api.utils.System2;
 import org.sonar.core.util.UuidFactory;
 import org.sonar.db.Dao;
 import org.sonar.db.DbSession;
 import org.sonar.db.audit.AuditPersister;
 import org.sonar.db.audit.model.ComponentNewValue;
+import org.sonar.db.component.ComponentQualifiers;
 import org.sonar.db.component.KeyWithUuidDto;
 import org.sonar.db.project.ApplicationProjectDto;
 
@@ -95,6 +97,16 @@ public class PortfolioDao implements Dao {
     return mapper(dbSession).selectUuidsByKey(rootKey);
   }
 
+  public Map<String, Integer> countPortfoliosByMode(DbSession dbSession) {
+    return mapper(dbSession).countPortfoliosByMode().stream().collect(Collectors.toMap(ModeCount::getSelectionMode,
+      ModeCount::getCount));
+  }
+
+  public Map<String, Integer> countSubportfoliosByMode(DbSession dbSession) {
+    return mapper(dbSession).countSubportfoliosByMode().stream().collect(Collectors.toMap(ModeCount::getSelectionMode,
+      ModeCount::getCount));
+  }
+
   /*
    * Modify portfolios
    */
diff --git a/server/sonar-db-dao/src/main/java/org/sonar/db/portfolio/PortfolioMapper.java b/server/sonar-db-dao/src/main/java/org/sonar/db/portfolio/PortfolioMapper.java
index 05c6225719e..325ad3c2038 100644
--- a/server/sonar-db-dao/src/main/java/org/sonar/db/portfolio/PortfolioMapper.java
+++ b/server/sonar-db-dao/src/main/java/org/sonar/db/portfolio/PortfolioMapper.java
@@ -116,4 +116,7 @@ public interface PortfolioMapper {
   List<PortfolioDto> selectRootOfReferencersToAppBranch(@Param("appUuid") String appUuid, @Param("appBranchKey") String appBranchKey);
 
   List<KeyWithUuidDto> selectUuidsByKey(@Param("rootKey") String rootKey);
+
+  List<ModeCount> countPortfoliosByMode();
+  List<ModeCount> countSubportfoliosByMode();
 }
diff --git a/server/sonar-db-dao/src/main/resources/org/sonar/db/portfolio/PortfolioMapper.xml b/server/sonar-db-dao/src/main/resources/org/sonar/db/portfolio/PortfolioMapper.xml
index 2071d83028c..341e8cb776a 100644
--- a/server/sonar-db-dao/src/main/resources/org/sonar/db/portfolio/PortfolioMapper.xml
+++ b/server/sonar-db-dao/src/main/resources/org/sonar/db/portfolio/PortfolioMapper.xml
@@ -454,6 +454,24 @@
     WHERE pr.reference_uuid =  #{referenceUuid,jdbcType=VARCHAR}
   </select>
 
+  <select id="countPortfoliosByMode" resultType="org.sonar.db.portfolio.ModeCount">
+    SELECT
+      selection_mode AS selectionMode,
+      count(1) AS count
+    FROM portfolios
+    WHERE parent_uuid IS NULL
+    GROUP BY selection_mode
+  </select>
+
+    <select id="countSubportfoliosByMode" resultType="org.sonar.db.portfolio.ModeCount">
+    SELECT
+      selection_mode AS selectionMode,
+      count(1) AS count
+    FROM portfolios
+    WHERE parent_uuid IS NOT NULL
+    GROUP BY selection_mode
+  </select>
+
   <delete id="deleteReferencesTo" parameterType="String">
     DELETE FROM portfolio_references
     WHERE reference_uuid =  #{referenceUuid,jdbcType=VARCHAR}
diff --git a/server/sonar-db-dao/src/test/java/org/sonar/db/portfolio/ModeCountTest.java b/server/sonar-db-dao/src/test/java/org/sonar/db/portfolio/ModeCountTest.java
new file mode 100644
index 00000000000..28225555a31
--- /dev/null
+++ b/server/sonar-db-dao/src/test/java/org/sonar/db/portfolio/ModeCountTest.java
@@ -0,0 +1,37 @@
+/*
+ * SonarQube
+ * Copyright (C) 2009-2024 SonarSource SA
+ * mailto:info AT sonarsource DOT com
+ *
+ * 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 Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ */
+package org.sonar.db.portfolio;
+
+import org.junit.jupiter.api.Test;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+class ModeCountTest {
+
+  @Test
+  void testGetters() {
+    ModeCount modeCount = new ModeCount("mode", 1);
+    assertThat(modeCount.getSelectionMode()).isEqualTo("mode");
+    assertThat(modeCount.getCount()).isOne();
+    modeCount = new ModeCount();
+    assertThat(modeCount.getSelectionMode()).isNull();
+    assertThat(modeCount.getCount()).isZero();
+  }
+}
diff --git a/server/sonar-webserver/src/main/java/org/sonar/server/platform/platformlevel/PlatformLevel4.java b/server/sonar-webserver/src/main/java/org/sonar/server/platform/platformlevel/PlatformLevel4.java
index 3a1587f66a5..21977575c71 100644
--- a/server/sonar-webserver/src/main/java/org/sonar/server/platform/platformlevel/PlatformLevel4.java
+++ b/server/sonar-webserver/src/main/java/org/sonar/server/platform/platformlevel/PlatformLevel4.java
@@ -195,6 +195,8 @@ import org.sonar.server.platform.db.CheckAnyonePermissionsAtStartup;
 import org.sonar.server.platform.telemetry.TelemetryFipsEnabledProvider;
 import org.sonar.server.platform.telemetry.TelemetryMQRModePropertyProvider;
 import org.sonar.server.platform.telemetry.TelemetryNclocProvider;
+import org.sonar.server.platform.telemetry.TelemetryPortfolioSelectionModeProvider;
+import org.sonar.server.platform.telemetry.TelemetrySubportfolioSelectionModeProvider;
 import org.sonar.server.platform.telemetry.TelemetryUserEnabledProvider;
 import org.sonar.server.platform.telemetry.TelemetryVersionProvider;
 import org.sonar.server.platform.web.ActionDeprecationLoggerInterceptor;
@@ -682,6 +684,8 @@ public class PlatformLevel4 extends PlatformLevel {
       TelemetryNclocProvider.class,
       TelemetryUserEnabledProvider.class,
       TelemetryFipsEnabledProvider.class,
+      TelemetrySubportfolioSelectionModeProvider.class,
+      TelemetryPortfolioSelectionModeProvider.class,
 
       // Reports telemetry
       TelemetryApplicationSubscriptionsProvider.class,
diff --git a/server/sonar-webserver/src/main/java/org/sonar/server/platform/telemetry/TelemetryPortfolioSelectionModeProvider.java b/server/sonar-webserver/src/main/java/org/sonar/server/platform/telemetry/TelemetryPortfolioSelectionModeProvider.java
new file mode 100644
index 00000000000..97545de54b6
--- /dev/null
+++ b/server/sonar-webserver/src/main/java/org/sonar/server/platform/telemetry/TelemetryPortfolioSelectionModeProvider.java
@@ -0,0 +1,45 @@
+/*
+ * SonarQube
+ * Copyright (C) 2009-2024 SonarSource SA
+ * mailto:info AT sonarsource DOT com
+ *
+ * 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 Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ */
+package org.sonar.server.platform.telemetry;
+
+import java.util.Map;
+import org.sonar.db.DbClient;
+import org.sonar.db.DbSession;
+import org.sonar.telemetry.core.AbstractTelemetryDataProvider;
+import org.sonar.telemetry.core.Dimension;
+import org.sonar.telemetry.core.Granularity;
+import org.sonar.telemetry.core.TelemetryDataType;
+
+public class TelemetryPortfolioSelectionModeProvider extends AbstractTelemetryDataProvider<Integer> {
+  private static final String METRIC_KEY = "portfolio_using_selection_mode";
+  private final DbClient dbClient;
+
+  public TelemetryPortfolioSelectionModeProvider(DbClient dbClient) {
+    super(METRIC_KEY, Dimension.INSTALLATION, Granularity.ADHOC, TelemetryDataType.INTEGER);
+    this.dbClient = dbClient;
+  }
+
+  @Override
+  public Map<String, Integer> getValues() {
+    try (DbSession dbSession = dbClient.openSession(false)) {
+      return dbClient.portfolioDao().countPortfoliosByMode(dbSession);
+    }
+  }
+}
diff --git a/server/sonar-webserver/src/main/java/org/sonar/server/platform/telemetry/TelemetrySubportfolioSelectionModeProvider.java b/server/sonar-webserver/src/main/java/org/sonar/server/platform/telemetry/TelemetrySubportfolioSelectionModeProvider.java
new file mode 100644
index 00000000000..8fa49251275
--- /dev/null
+++ b/server/sonar-webserver/src/main/java/org/sonar/server/platform/telemetry/TelemetrySubportfolioSelectionModeProvider.java
@@ -0,0 +1,45 @@
+/*
+ * SonarQube
+ * Copyright (C) 2009-2024 SonarSource SA
+ * mailto:info AT sonarsource DOT com
+ *
+ * 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 Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ */
+package org.sonar.server.platform.telemetry;
+
+import java.util.Map;
+import org.sonar.db.DbClient;
+import org.sonar.db.DbSession;
+import org.sonar.telemetry.core.AbstractTelemetryDataProvider;
+import org.sonar.telemetry.core.Dimension;
+import org.sonar.telemetry.core.Granularity;
+import org.sonar.telemetry.core.TelemetryDataType;
+
+public class TelemetrySubportfolioSelectionModeProvider extends AbstractTelemetryDataProvider<Integer> {
+  private static final String METRIC_KEY = "subportfolio_using_selection_mode";
+  private final DbClient dbClient;
+
+  public TelemetrySubportfolioSelectionModeProvider(DbClient dbClient) {
+    super(METRIC_KEY, Dimension.INSTALLATION, Granularity.ADHOC, TelemetryDataType.INTEGER);
+    this.dbClient = dbClient;
+  }
+
+  @Override
+  public Map<String, Integer> getValues() {
+    try (DbSession dbSession = dbClient.openSession(false)) {
+      return dbClient.portfolioDao().countSubportfoliosByMode(dbSession);
+    }
+  }
+}
diff --git a/server/sonar-webserver/src/test/java/org/sonar/server/platform/telemetry/TelemetryPortfolioSelectionModeProviderTest.java b/server/sonar-webserver/src/test/java/org/sonar/server/platform/telemetry/TelemetryPortfolioSelectionModeProviderTest.java
new file mode 100644
index 00000000000..9dedd49a8c6
--- /dev/null
+++ b/server/sonar-webserver/src/test/java/org/sonar/server/platform/telemetry/TelemetryPortfolioSelectionModeProviderTest.java
@@ -0,0 +1,52 @@
+/*
+ * SonarQube
+ * Copyright (C) 2009-2024 SonarSource SA
+ * mailto:info AT sonarsource DOT com
+ *
+ * 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 Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ */
+package org.sonar.server.platform.telemetry;
+
+import java.util.Map;
+import org.junit.jupiter.api.Test;
+import org.sonar.db.DbClient;
+import org.sonar.db.portfolio.PortfolioDao;
+import org.sonar.telemetry.core.Dimension;
+import org.sonar.telemetry.core.Granularity;
+import org.sonar.telemetry.core.TelemetryDataType;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
+
+class TelemetryPortfolioSelectionModeProviderTest {
+  private final DbClient dbClient = mock(DbClient.class);
+  private final PortfolioDao portfolioDao = mock(PortfolioDao.class);
+
+  @Test
+  void testGetters() {
+    when(dbClient.portfolioDao()).thenReturn(portfolioDao);
+    TelemetryPortfolioSelectionModeProvider underTest = new TelemetryPortfolioSelectionModeProvider(dbClient);
+
+    assertThat(underTest.getMetricKey()).isEqualTo("portfolio_using_selection_mode");
+    assertThat(underTest.getDimension()).isEqualTo(Dimension.INSTALLATION);
+    assertThat(underTest.getGranularity()).isEqualTo(Granularity.ADHOC);
+    assertThat(underTest.getType()).isEqualTo(TelemetryDataType.INTEGER);
+    Map<String, Integer> expected = Map.of("REGEXP", 42, "REST", 7);
+    when(portfolioDao.countPortfoliosByMode(any())).thenReturn(expected);
+    assertThat(underTest.getValues()).containsAllEntriesOf(expected);
+  }
+}
diff --git a/server/sonar-webserver/src/test/java/org/sonar/server/platform/telemetry/TelemetrySubportfolioSelectionModeProviderTest.java b/server/sonar-webserver/src/test/java/org/sonar/server/platform/telemetry/TelemetrySubportfolioSelectionModeProviderTest.java
new file mode 100644
index 00000000000..50ddfd895a6
--- /dev/null
+++ b/server/sonar-webserver/src/test/java/org/sonar/server/platform/telemetry/TelemetrySubportfolioSelectionModeProviderTest.java
@@ -0,0 +1,53 @@
+/*
+ * SonarQube
+ * Copyright (C) 2009-2024 SonarSource SA
+ * mailto:info AT sonarsource DOT com
+ *
+ * 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 Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ */
+package org.sonar.server.platform.telemetry;
+
+import java.util.Map;
+import org.junit.jupiter.api.Test;
+import org.sonar.db.DbClient;
+import org.sonar.db.portfolio.PortfolioDao;
+import org.sonar.telemetry.core.Dimension;
+import org.sonar.telemetry.core.Granularity;
+import org.sonar.telemetry.core.TelemetryDataType;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
+
+class TelemetrySubportfolioSelectionModeProviderTest {
+  private final DbClient dbClient = mock(DbClient.class);
+  private final PortfolioDao portfolioDao = mock(PortfolioDao.class);
+
+  @Test
+  void testGetters() {
+    when(dbClient.portfolioDao()).thenReturn(portfolioDao);
+    TelemetrySubportfolioSelectionModeProvider underTest = new TelemetrySubportfolioSelectionModeProvider(dbClient);
+
+    assertThat(underTest.getMetricKey()).isEqualTo("subportfolio_using_selection_mode");
+    assertThat(underTest.getDimension()).isEqualTo(Dimension.INSTALLATION);
+    assertThat(underTest.getGranularity()).isEqualTo(Granularity.ADHOC);
+    assertThat(underTest.getType()).isEqualTo(TelemetryDataType.INTEGER);
+    Map<String, Integer> expected = Map.of("REGEXP", 42, "REST", 7);
+    when(portfolioDao.countSubportfoliosByMode(any())).thenReturn(expected);
+    assertThat(underTest.getValues()).containsAllEntriesOf(expected);
+  }
+
+}