This is an automated email from the ASF dual-hosted git repository.
klesh pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/devlake.git
The following commit(s) were added to refs/heads/main by this push:
new b34d761c3 fix(sonarqube): support long issue code block components
(#8986)
b34d761c3 is described below
commit b34d761c378920efbcd4094c543b4ac6b3cf1c76
Author: Dirk <[email protected]>
AuthorDate: Sun Jul 19 05:02:14 2026 +0200
fix(sonarqube): support long issue code block components (#8986)
Signed-off-by: DoDiODev <[email protected]>
---
.../codequality/cq_issue_code_blocks.go | 2 +-
...hange_cq_issue_code_blocks_component_to_text.go | 44 +++++
backend/core/models/migrationscripts/register.go | 1 +
.../e2e/issue_code_block_long_component_test.go | 199 +++++++++++++++++++++
...60701_change_issue_code_block_component_type.go | 44 +++++
.../sonarqube/models/migrationscripts/register.go | 1 +
.../sonarqube/models/sonarqube_issue_code_block.go | 2 +-
.../tasks/issue_code_blocks_convertor_test.go} | 38 ++--
8 files changed, 315 insertions(+), 16 deletions(-)
diff --git
a/backend/core/models/domainlayer/codequality/cq_issue_code_blocks.go
b/backend/core/models/domainlayer/codequality/cq_issue_code_blocks.go
index 294bc5d3c..c522fc5cc 100644
--- a/backend/core/models/domainlayer/codequality/cq_issue_code_blocks.go
+++ b/backend/core/models/domainlayer/codequality/cq_issue_code_blocks.go
@@ -22,7 +22,7 @@ import
"github.com/apache/incubator-devlake/core/models/domainlayer"
type CqIssueCodeBlock struct {
domainlayer.DomainEntity
IssueKey string `json:"key" gorm:"index"`
- Component string `gorm:"index"`
+ Component string `gorm:"type:text"`
StartLine int
EndLine int
StartOffset int
diff --git
a/backend/core/models/migrationscripts/20260701_change_cq_issue_code_blocks_component_to_text.go
b/backend/core/models/migrationscripts/20260701_change_cq_issue_code_blocks_component_to_text.go
new file mode 100644
index 000000000..b84d1d9ce
--- /dev/null
+++
b/backend/core/models/migrationscripts/20260701_change_cq_issue_code_blocks_component_to_text.go
@@ -0,0 +1,44 @@
+/*
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package migrationscripts
+
+import (
+ "github.com/apache/incubator-devlake/core/context"
+ "github.com/apache/incubator-devlake/core/errors"
+ "github.com/apache/incubator-devlake/core/plugin"
+)
+
+var _ plugin.MigrationScript = (*changeCqIssueCodeBlocksComponentToText)(nil)
+
+type changeCqIssueCodeBlocksComponentToText struct{}
+
+func (script *changeCqIssueCodeBlocksComponentToText) Up(basicRes
context.BasicRes) errors.Error {
+ db := basicRes.GetDal()
+ if err := db.DropIndexes("cq_issue_code_blocks",
"idx_cq_issue_code_blocks_component"); err != nil {
+ return err
+ }
+ return db.ModifyColumnType("cq_issue_code_blocks", "component", "text")
+}
+
+func (*changeCqIssueCodeBlocksComponentToText) Version() uint64 {
+ return 20260701000000
+}
+
+func (*changeCqIssueCodeBlocksComponentToText) Name() string {
+ return "change cq_issue_code_blocks.component type to text"
+}
diff --git a/backend/core/models/migrationscripts/register.go
b/backend/core/models/migrationscripts/register.go
index 76f2e9683..adef98ef8 100644
--- a/backend/core/models/migrationscripts/register.go
+++ b/backend/core/models/migrationscripts/register.go
@@ -145,6 +145,7 @@ func All() []plugin.MigrationScript {
new(modifyCicdDeploymentsToText),
new(increaseCqIssuesProjectKeyLength),
new(addAuthSessions),
+ new(changeCqIssueCodeBlocksComponentToText),
new(addCqProjectMetricsHistory),
}
}
diff --git
a/backend/plugins/sonarqube/e2e/issue_code_block_long_component_test.go
b/backend/plugins/sonarqube/e2e/issue_code_block_long_component_test.go
new file mode 100644
index 000000000..8076fa3a8
--- /dev/null
+++ b/backend/plugins/sonarqube/e2e/issue_code_block_long_component_test.go
@@ -0,0 +1,199 @@
+/*
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package e2e
+
+import (
+ "strings"
+ "testing"
+ "time"
+
+ "github.com/apache/incubator-devlake/core/models/common"
+ "github.com/apache/incubator-devlake/core/models/domainlayer"
+
"github.com/apache/incubator-devlake/core/models/domainlayer/codequality"
+ coremigrations
"github.com/apache/incubator-devlake/core/models/migrationscripts"
+ "github.com/apache/incubator-devlake/core/plugin"
+ "github.com/apache/incubator-devlake/helpers/e2ehelper"
+ implcontext "github.com/apache/incubator-devlake/impls/context"
+ "github.com/apache/incubator-devlake/plugins/sonarqube/impl"
+ "github.com/apache/incubator-devlake/plugins/sonarqube/models"
+ sonarqubemigrations
"github.com/apache/incubator-devlake/plugins/sonarqube/models/migrationscripts"
+ "github.com/apache/incubator-devlake/plugins/sonarqube/tasks"
+ "github.com/stretchr/testify/require"
+)
+
+type sonarqubeIssueCodeBlockBeforeText struct {
+ ConnectionId uint64 `gorm:"primaryKey"`
+ Id string `gorm:"primaryKey"`
+ IssueKey string `gorm:"index"`
+ Component string `gorm:"index;type:varchar(500)"`
+ StartLine int
+ EndLine int
+ StartOffset int
+ EndOffset int
+ Msg string
+ common.NoPKModel
+}
+
+func (sonarqubeIssueCodeBlockBeforeText) TableName() string {
+ return "_tool_sonarqube_issue_code_blocks"
+}
+
+type cqIssueCodeBlockBeforeText struct {
+ domainlayer.DomainEntity
+ IssueKey string `json:"key" gorm:"index"`
+ Component string `gorm:"index"`
+ StartLine int
+ EndLine int
+ StartOffset int
+ EndOffset int
+ Msg string
+}
+
+func (cqIssueCodeBlockBeforeText) TableName() string {
+ return "cq_issue_code_blocks"
+}
+
+func TestSonarqubeIssueCodeBlockLongComponent(t *testing.T) {
+ var sonarqube impl.Sonarqube
+ dataflowTester := e2ehelper.NewDataFlowTester(t, "sonarqube", sonarqube)
+ dataflowTester.FlushTabler(&models.SonarqubeIssue{})
+ require.NoError(t, dataflowTester.Db.Migrator().DropTable(
+ &sonarqubeIssueCodeBlockBeforeText{},
+ &cqIssueCodeBlockBeforeText{},
+ ))
+ require.NoError(t, dataflowTester.Db.AutoMigrate(
+ &sonarqubeIssueCodeBlockBeforeText{},
+ &cqIssueCodeBlockBeforeText{},
+ ))
+
+ existingComponent := "existing:component"
+ require.NoError(t,
dataflowTester.Db.Create(&sonarqubeIssueCodeBlockBeforeText{
+ ConnectionId: 1,
+ Id: "existing-tool-block",
+ IssueKey: "existing-issue",
+ Component: existingComponent,
+ }).Error)
+ require.NoError(t, dataflowTester.Db.Create(&cqIssueCodeBlockBeforeText{
+ DomainEntity: domainlayer.DomainEntity{Id:
"existing-domain-block"},
+ IssueKey: "existing-domain-issue",
+ Component: existingComponent,
+ }).Error)
+
+ basicRes := implcontext.NewDefaultBasicRes(dataflowTester.Cfg,
dataflowTester.Log, dataflowTester.Dal)
+ runMigration(t, coremigrations.All(), "change
cq_issue_code_blocks.component type to text", basicRes)
+ runMigration(t, sonarqubemigrations.All(), "change
_tool_sonarqube_issue_code_blocks.component type to text", basicRes)
+ assertTextColumnWithoutIndex(t, dataflowTester, "cq_issue_code_blocks")
+ assertTextColumnWithoutIndex(t, dataflowTester,
"_tool_sonarqube_issue_code_blocks")
+
+ var migratedToolBlock sonarqubeIssueCodeBlockBeforeText
+ require.NoError(t, dataflowTester.Db.First(&migratedToolBlock, "id =
?", "existing-tool-block").Error)
+ require.Equal(t, existingComponent, migratedToolBlock.Component)
+ var migratedDomainBlock cqIssueCodeBlockBeforeText
+ require.NoError(t, dataflowTester.Db.First(&migratedDomainBlock, "id =
?", "existing-domain-block").Error)
+ require.Equal(t, existingComponent, migratedDomainBlock.Component)
+ require.NoError(t, dataflowTester.Db.Delete(&migratedToolBlock).Error)
+ require.NoError(t, dataflowTester.Db.Delete(&migratedDomainBlock).Error)
+
+ longComponent256 := "project:" + strings.Repeat("a", 256)
+ longComponent500 := "project:" + strings.Repeat("b", 500)
+ require.Greater(t, len(longComponent256), 256)
+ require.Greater(t, len(longComponent500), 500)
+
+ issueKey := "TEST-LONG-COMPONENT-ISSUE"
+ projectKey := "test-long-component-project"
+ result := dataflowTester.Db.Create(&models.SonarqubeIssue{
+ ConnectionId: 1,
+ IssueKey: issueKey,
+ ProjectKey: projectKey,
+ Component: longComponent500,
+ Rule: "java:S3776",
+ Severity: "CRITICAL",
+ })
+ require.NoError(t, result.Error)
+
+ codeBlocks := []*models.SonarqubeIssueCodeBlock{
+ {
+ ConnectionId: 1,
+ Id: "test-long-component-block-256",
+ IssueKey: issueKey,
+ Component: longComponent256,
+ Msg: "component longer than 256 characters",
+ },
+ {
+ ConnectionId: 1,
+ Id: "test-long-component-block-500",
+ IssueKey: issueKey,
+ Component: longComponent500,
+ Msg: "component longer than 500 characters",
+ },
+ }
+ for _, block := range codeBlocks {
+ require.NoError(t, dataflowTester.Db.Create(block).Error)
+ }
+
+ dataflowTester.Subtask(tasks.ConvertIssueCodeBlocksMeta,
&tasks.SonarqubeTaskData{
+ Options: &tasks.SonarqubeOptions{
+ ConnectionId: 1,
+ ProjectKey: projectKey,
+ },
+ TaskStartTime: time.Now(),
+ })
+
+ var domainBlocks []codequality.CqIssueCodeBlock
+ require.NoError(t, dataflowTester.Db.Find(&domainBlocks).Error)
+ require.Len(t, domainBlocks, 2)
+ require.ElementsMatch(t,
+ []string{longComponent256, longComponent500},
+ []string{domainBlocks[0].Component, domainBlocks[1].Component},
+ )
+
+ var toolBlocks []models.SonarqubeIssueCodeBlock
+ require.NoError(t, dataflowTester.Db.Where(
+ "connection_id = ? AND issue_key = ?", 1, issueKey,
+ ).Find(&toolBlocks).Error)
+ require.Len(t, toolBlocks, 2)
+ require.ElementsMatch(t,
+ []string{longComponent256, longComponent500},
+ []string{toolBlocks[0].Component, toolBlocks[1].Component},
+ )
+}
+
+func runMigration(t *testing.T, scripts []plugin.MigrationScript, name string,
basicRes *implcontext.DefaultBasicRes) {
+ t.Helper()
+ for _, script := range scripts {
+ if script.Name() == name {
+ require.NoError(t, script.Up(basicRes))
+ return
+ }
+ }
+ require.Fail(t, "migration is not registered", name)
+}
+
+func assertTextColumnWithoutIndex(t *testing.T, dataflowTester
*e2ehelper.DataFlowTester, table string) {
+ t.Helper()
+ columnTypes, err := dataflowTester.Db.Migrator().ColumnTypes(table)
+ require.NoError(t, err)
+ for _, columnType := range columnTypes {
+ if columnType.Name() == "component" {
+ require.Contains(t,
strings.ToLower(columnType.DatabaseTypeName()), "text")
+ require.False(t,
dataflowTester.Db.Migrator().HasIndex(table, "idx_"+table+"_component"))
+ return
+ }
+ }
+ require.Fail(t, "component column not found", table)
+}
diff --git
a/backend/plugins/sonarqube/models/migrationscripts/20260701_change_issue_code_block_component_type.go
b/backend/plugins/sonarqube/models/migrationscripts/20260701_change_issue_code_block_component_type.go
new file mode 100644
index 000000000..3ba3a00eb
--- /dev/null
+++
b/backend/plugins/sonarqube/models/migrationscripts/20260701_change_issue_code_block_component_type.go
@@ -0,0 +1,44 @@
+/*
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package migrationscripts
+
+import (
+ "github.com/apache/incubator-devlake/core/context"
+ "github.com/apache/incubator-devlake/core/errors"
+ "github.com/apache/incubator-devlake/core/plugin"
+)
+
+var _ plugin.MigrationScript = (*changeIssueCodeBlockComponentType)(nil)
+
+type changeIssueCodeBlockComponentType struct{}
+
+func (script *changeIssueCodeBlockComponentType) Up(basicRes context.BasicRes)
errors.Error {
+ db := basicRes.GetDal()
+ if err := db.DropIndexes("_tool_sonarqube_issue_code_blocks",
"idx__tool_sonarqube_issue_code_blocks_component"); err != nil {
+ return err
+ }
+ return db.ModifyColumnType("_tool_sonarqube_issue_code_blocks",
"component", "text")
+}
+
+func (*changeIssueCodeBlockComponentType) Version() uint64 {
+ return 20260701000000
+}
+
+func (*changeIssueCodeBlockComponentType) Name() string {
+ return "change _tool_sonarqube_issue_code_blocks.component type to text"
+}
diff --git a/backend/plugins/sonarqube/models/migrationscripts/register.go
b/backend/plugins/sonarqube/models/migrationscripts/register.go
index 113341921..4e1e590b9 100644
--- a/backend/plugins/sonarqube/models/migrationscripts/register.go
+++ b/backend/plugins/sonarqube/models/migrationscripts/register.go
@@ -39,6 +39,7 @@ func All() []plugin.MigrationScript {
new(addOrgToConn),
new(addIssueImpacts),
new(extendSonarqubeFieldSize),
+ new(changeIssueCodeBlockComponentType),
new(addProjectMetricsHistory),
}
}
diff --git a/backend/plugins/sonarqube/models/sonarqube_issue_code_block.go
b/backend/plugins/sonarqube/models/sonarqube_issue_code_block.go
index b5bb58bdd..b36386338 100644
--- a/backend/plugins/sonarqube/models/sonarqube_issue_code_block.go
+++ b/backend/plugins/sonarqube/models/sonarqube_issue_code_block.go
@@ -23,7 +23,7 @@ type SonarqubeIssueCodeBlock struct {
ConnectionId uint64 `gorm:"primaryKey"`
Id string `gorm:"primaryKey"`
IssueKey string `gorm:"index"`
- Component string `gorm:"index;type:varchar(500)"`
+ Component string `gorm:"type:text"`
StartLine int
EndLine int
StartOffset int
diff --git
a/backend/core/models/domainlayer/codequality/cq_issue_code_blocks.go
b/backend/plugins/sonarqube/tasks/issue_code_blocks_convertor_test.go
similarity index 51%
copy from backend/core/models/domainlayer/codequality/cq_issue_code_blocks.go
copy to backend/plugins/sonarqube/tasks/issue_code_blocks_convertor_test.go
index 294bc5d3c..c3d703fe2 100644
--- a/backend/core/models/domainlayer/codequality/cq_issue_code_blocks.go
+++ b/backend/plugins/sonarqube/tasks/issue_code_blocks_convertor_test.go
@@ -15,21 +15,31 @@ See the License for the specific language governing
permissions and
limitations under the License.
*/
-package codequality
+package tasks
-import "github.com/apache/incubator-devlake/core/models/domainlayer"
+import (
+ "reflect"
+ "testing"
-type CqIssueCodeBlock struct {
- domainlayer.DomainEntity
- IssueKey string `json:"key" gorm:"index"`
- Component string `gorm:"index"`
- StartLine int
- EndLine int
- StartOffset int
- EndOffset int
- Msg string
-}
+
"github.com/apache/incubator-devlake/core/models/domainlayer/codequality"
+ "github.com/apache/incubator-devlake/plugins/sonarqube/models"
+ "github.com/stretchr/testify/require"
+)
+
+func TestIssueCodeBlockComponentIsText(t *testing.T) {
+ testCases := []struct {
+ name string
+ model interface{}
+ }{
+ {name: "tool layer", model: models.SonarqubeIssueCodeBlock{}},
+ {name: "domain layer", model: codequality.CqIssueCodeBlock{}},
+ }
-func (CqIssueCodeBlock) TableName() string {
- return "cq_issue_code_blocks"
+ for _, testCase := range testCases {
+ t.Run(testCase.name, func(t *testing.T) {
+ field, ok :=
reflect.TypeOf(testCase.model).FieldByName("Component")
+ require.True(t, ok)
+ require.Equal(t, "type:text", field.Tag.Get("gorm"))
+ })
+ }
}
