[issuegenerator] Trim module name when creating a new issue (#864)

* [issuegenerator] Trim module name when creating a new issue

* add changelog

* Use central method for trimming prefix, add tests

* Fix lint failure

* Remove unnecessary prefix check

* Changes requested in code review

- expected -> want
- Only use module name in test, don't include https:// prefix
- Whitespace
- require -> assert
- Print all input args for failing tests

Author: crobert-1

.chloggen/trim_issue_title.yaml

@@ -0,0 +1,16 @@
+# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
+change_type: bug_fix
+
+# The name of the component, or a single word describing the area of concern, (e.g. crosslink)
+component: issuegenerator
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Trim repository prefix from new issue titles
+
+# One or more tracking issues related to the change
+issues: [864]
+
+# (Optional) One or more lines of additional information to render under the primary note.
+# These lines will be padded with 2 spaces and then inserted directly into the document.
+# Use pipe (|) for multiline entries.
+subtext:

issuegenerator/main.go

@@ -93,6 +93,10 @@ func newReportGenerator() *reportGenerator {
 	}
 }
 
+func trimModule(owner, repo, module string) string {
+	return strings.TrimPrefix(module, fmt.Sprintf("github.com/%s/%s/", owner, repo))
+}
+
 func main() {
 	pathToArtifacts := flag.String("path", "", "Path to the directory with test results")
 	flag.Parse()
@@ -255,7 +259,7 @@ func (rg *reportGenerator) getExistingIssue(module string) *github.Issue {
 		rg.handleBadResponses(response)
 	}
 
-	module = strings.TrimPrefix(module, fmt.Sprintf("github.com/%s/%s/", rg.envVariables[githubOwner], rg.envVariables[githubRepository]))
+	module = trimModule(rg.envVariables[githubOwner], rg.envVariables[githubRepository], module)
 	requiredTitle := strings.Replace(issueTitleTemplate, "${module}", module, 1)
 	for _, issue := range issues {
 		if *issue.Title == requiredTitle {
@@ -294,7 +298,8 @@ func (rg *reportGenerator) commentOnIssue(issue *github.Issue) *github.IssueComm
 
 // createIssue creates a new GitHub Issue corresponding to a build failure.
 func (rg *reportGenerator) createIssue(r report) *github.Issue {
-	title := strings.Replace(issueTitleTemplate, "${module}", r.module, 1)
+	trimmedModule := trimModule(rg.envVariables[githubOwner], rg.envVariables[githubRepository], r.module)
+	title := strings.Replace(issueTitleTemplate, "${module}", trimmedModule, 1)
 	body := os.Expand(issueBodyTemplate, rg.templateHelper)
 
 	issue, response, err := rg.client.Issues.Create(

issuegenerator/main_test.go

@@ -18,6 +18,7 @@ import (
 	"testing"
 
 	"github.com/joshdk/go-junit"
+	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 )
 
@@ -108,3 +109,34 @@ func TestIngestArtifacts(t *testing.T) {
 	require.Equal(t, expectedTestResults, rg.testSuites)
 
 }
+
+func TestTrimPath(t *testing.T) {
+	tests := []struct {
+		name       string
+		owner      string
+		repo       string
+		module     string
+		wantModule string
+	}{
+		{
+			name:       "Test contrib host metrics integration path",
+			owner:      "open-telemetry",
+			repo:       "opentelemetry-collector-contrib",
+			module:     "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/hostmetricsreceiver/integration_test.go",
+			wantModule: "receiver/hostmetricsreceiver/integration_test.go",
+		},
+		{
+			name:       "Test core otlphttp exporter test path",
+			owner:      "open-telemetry",
+			repo:       "opentelemetry-collector",
+			module:     "github.com/open-telemetry/opentelemetry-collector/exporter/otlphttpexporter/otlp_test.go",
+			wantModule: "exporter/otlphttpexporter/otlp_test.go",
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			assert.Equal(t, tt.wantModule, trimModule(tt.owner, tt.repo, tt.module), "owner: %s, repo: %s, module: %s, wantModule: %s", tt.owner, tt.repo, tt.module, tt.wantModule)
+		})
+	}
+}