check if link in tmetric is a valid OP link (#15)

Co-authored-by: Sawjan Gurung <saw.jan.grg3e@gmail.com>

Author: individual-it

cmd/copy.go

@@ -44,7 +44,7 @@ func checkTmetricEntries(tmetricUser tmetric.User, config *config.Config) ([]tme
 		)
 	}
 
-	if len(tmetric.GetEntriesWithoutLinkToOpenProject(timeEntries)) > 0 {
+	if len(tmetric.GetEntriesWithoutLinkToOpenProject(config, timeEntries)) > 0 {
 		return nil, fmt.Errorf(
 			"some time-entries are not linked to an OpenProject work-package, run the 'check tmetric' command to fix it",
 		)

cmd/tmetric.go

@@ -42,22 +42,15 @@ func validateOpenProjectWorkPackage(input string) error {
 }
 
 func handleEntriesWithoutIssue(timeEntries []tmetric.TimeEntry, tmetricUser tmetric.User, config *config.Config) error {
-	// get all entries that belong to the client and do not have an external link
-	var entriesWithoutIssue []tmetric.TimeEntry
-	for _, entry := range timeEntries {
-		if entry.Project.Client.Id == config.ClientIdInTmetric && entry.Task.ExternalLink.IssueId == "" {
-			entriesWithoutIssue = append(entriesWithoutIssue, entry)
-		}
-	}
-
-	if len(entriesWithoutIssue) > 0 {
+	entriesWithoutLinkToOpenProject := tmetric.GetEntriesWithoutLinkToOpenProject(config, timeEntries)
+	if len(entriesWithoutLinkToOpenProject) > 0 {
 		fmt.Println("Some time-entries do not have any workpackages assigned")
 	}
 
 	spinner := newSpinner()
 	defer spinner.Stop()
 
-	for _, entry := range entriesWithoutIssue {
+	for _, entry := range entriesWithoutLinkToOpenProject {
 		prompt := promptui.Prompt{
 			Label: fmt.Sprintf(
 				"%v => %v %v-%v. Provide a WP number to be assigned to this time-entry (Enter to skip)",

config/config.go

@@ -32,6 +32,7 @@ type Config struct {
 	TmetricAPIV3BaseUrl                string
 	TmetricDummyProjectId              int
 	TmetricTagTransferredToOpenProject string
+	TmetricExternalTaskLink            string
 }
 
 func NewConfig() *Config {
@@ -69,5 +70,8 @@ func NewConfig() *Config {
 		TmetricAPIV3BaseUrl:                "https://app.tmetric.com/api/v3/",
 		TmetricDummyProjectId:              tmetricDummyProjectId,
 		TmetricTagTransferredToOpenProject: "transferred-to-openproject",
+		// this value has always to be "https://community.openproject.org"
+		// otherwise tmetric does not recognize the integration and does not allow to create the external task
+		TmetricExternalTaskLink:            "https://community.openproject.org/",
 	}
 }

tmetric/timeentry.go

@@ -174,9 +174,18 @@ func (timeEntry *TimeEntry) GetPossibleWorkTypes(config config.Config, user User
 // GetIssueIdAsInt returns the issue id as an integer
 // the issue Id in tmetric is a string e.g. #1234, but for OpenProject we need the integer to construct the URLs
 func (timeEntry *TimeEntry) GetIssueIdAsInt() (int, error) {
-	issueIdStr := regexp.MustCompile(`#(\d+)`).
-		FindStringSubmatch(timeEntry.Task.ExternalLink.IssueId)[1]
-	return strconv.Atoi(issueIdStr)
+	issueRegex, err := regexp.Compile(`#(\d+)`)
+	if err != nil {
+		return 0, err
+	}
+	issueIdStr := issueRegex.FindStringSubmatch(timeEntry.Task.ExternalLink.IssueId)
+	if len(issueIdStr) != 2 {
+		return 0, fmt.Errorf(
+			"could not find valid OpenProject workpackage id in tmetric task '%v'",
+			timeEntry.Task.ExternalLink.IssueId,
+		)
+	}
+	return strconv.Atoi(issueIdStr[1])
 }
 
 /*
@@ -187,9 +196,7 @@ func CreateDummyTimeEntry(
 	workPackage openproject.WorkPackage, tmetricUser User, config *config.Config,
 ) (*TimeEntry, error) {
 	dummyTimeEntry := NewDummyTimeEntry(workPackage, config.OpenProjectUrl, config.TmetricDummyProjectId)
-	// the serviceUrl for the dummy task has always to be "https://community.openproject.org"
-	// otherwise tmetric does not recognize the integration and does not allow to create the external task
-	dummyTimeEntry.ServiceUrl = "https://community.openproject.org"
+	dummyTimeEntry.ServiceUrl = config.TmetricExternalTaskLink
 	dummyTimerString, _ := json.Marshal(dummyTimeEntry)
 	httpClient := resty.New()
 	resp, err := httpClient.R().

tmetric/tmetric.go

@@ -6,6 +6,7 @@ import (
 	"github.com/JankariTech/OpenProjectTmetricIntegration/config"
 	"github.com/go-resty/resty/v2"
 	"sort"
+	"strings"
 )
 
 func GetAllTimeEntries(config *config.Config, tmetricUser User, startDate string, endDate string) ([]TimeEntry, error) {
@@ -83,10 +84,14 @@ func GetEntriesWithoutWorkType(timeEntries []TimeEntry) []TimeEntry {
 	return entriesWithoutWorkType
 }
 
-func GetEntriesWithoutLinkToOpenProject(timeEntries []TimeEntry) []TimeEntry {
+func GetEntriesWithoutLinkToOpenProject(config *config.Config, timeEntries []TimeEntry) []TimeEntry {
 	var entriesWithoutLink []TimeEntry
 	for _, entry := range timeEntries {
-		if entry.Task.Id == 0 {
+		_, err := entry.GetIssueIdAsInt()
+		if entry.Task.Id == 0 ||
+			err != nil ||
+			entry.Task.ExternalLink.IssueId == "" ||
+			(!strings.HasPrefix(entry.Task.ExternalLink.Link, config.TmetricExternalTaskLink+"work_packages")) {
 			entriesWithoutLink = append(entriesWithoutLink, entry)
 		}
 	}

tmetric/tmetric_test.go

@@ -8,6 +8,97 @@ import (
 	"testing"
 )
 
+func Test_GetEntriesWithoutLinkToOpenProject(t *testing.T) {
+	tests := []struct {
+		name string
+		task Task
+	}{
+		{
+			name: "empty task",
+			task: Task{},
+		},
+		{
+			name: "no external link",
+			task: Task{
+				Id:   123,
+				Name: "some WP",
+			},
+		},
+		{
+			name: "link is not to openproject",
+			task: Task{
+				Id:   345,
+				Name: "some WP",
+				ExternalLink: ExternalLink{
+					Link:    "https://some_host/work_packages/123",
+					IssueId: "#123",
+				},
+			},
+		},
+		{
+			name: "IssueId is empty",
+			task: Task{
+				Id:   345,
+				Name: "some WP",
+				ExternalLink: ExternalLink{
+					Link:    "https://community.openproject.org/work_packages/123",
+					IssueId: "",
+				},
+			},
+		},
+		{
+			name: "IssueId has wrong format",
+			task: Task{
+				Id:   345,
+				Name: "some WP",
+				ExternalLink: ExternalLink{
+					Link:    "https://community.openproject.org/work_packages/123",
+					IssueId: "!123",
+				},
+			},
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			// adds a correct entry at the beginning and the end and makes sure the invalid
+			// entry is still in the result
+			config := &config.Config{
+				ClientIdInTmetric:       123,
+				TmetricExternalTaskLink: "https://community.openproject.org/",
+			}
+			validTimeEntry := TimeEntry{
+				Project: Project{
+					Client: Client{Id: 123},
+					Name:   "Project1",
+				},
+				Note: "correct entry",
+				Task: Task{
+					Id:   345,
+					Name: "some WP",
+					ExternalLink: ExternalLink{
+						Link:    "https://community.openproject.org/work_packages/123",
+						IssueId: "#123",
+					},
+				},
+			}
+			invalidTimeEntry := TimeEntry{
+				Project: Project{
+					Client: Client{Id: 123},
+					Name:   "Project1",
+				},
+				Note: "invalid entry",
+				Task: tt.task,
+			}
+			timeEntriesToCheck := append([]TimeEntry{invalidTimeEntry}, validTimeEntry)
+			timeEntriesToCheck = append([]TimeEntry{validTimeEntry}, timeEntriesToCheck...)
+			result := GetEntriesWithoutLinkToOpenProject(config, timeEntriesToCheck)
+			if !reflect.DeepEqual(result, []TimeEntry{invalidTimeEntry}) {
+				t.Errorf("got %v, want %v", result, []TimeEntry{invalidTimeEntry})
+			}
+		})
+	}
+}
+
 func Test_GetEntriesWithoutWorkType(t *testing.T) {
 	type args struct {
 		timeEntries []TimeEntry