Add error checking to job url generator. (#137)

server/handlers/project_command_output_handler.go

@@ -31,7 +31,7 @@ type AsyncProjectCommandOutputHandler struct {
 
 // ProjectJobURLGenerator generates urls to view project's progress.
 type ProjectJobURLGenerator interface {
-	GenerateProjectJobURL(p models.ProjectCommandContext) string
+	GenerateProjectJobURL(p models.ProjectCommandContext) (string, error)
 }
 
 //go:generate pegomock generate -m --use-experimental-model-gen --package mocks -o mocks/mock_project_status_updater.go ProjectStatusUpdater
@@ -126,7 +126,11 @@ func (p *AsyncProjectCommandOutputHandler) Clear(ctx models.ProjectCommandContex
 }
 
 func (p *AsyncProjectCommandOutputHandler) SetJobURLWithStatus(ctx models.ProjectCommandContext, cmdName models.CommandName, status models.CommitStatus) error {
-	url := p.projectJobURLGenerator.GenerateProjectJobURL(ctx)
+	url, err := p.projectJobURLGenerator.GenerateProjectJobURL(ctx)
+
+	if err != nil {
+		return err
+	}
 	return p.projectStatusUpdater.UpdateProject(ctx, cmdName, status, url)
 }
 

server/handlers/project_command_output_handler_test.go

@@ -1,6 +1,7 @@
 package handlers_test
 
 import (
+	"errors"
 	"sync"
 	"testing"
 	"time"
@@ -225,12 +226,30 @@ func TestProjectCommandOutputHandler(t *testing.T) {
 			logger,
 		)
 
-		When(projectJobURLGenerator.GenerateProjectJobURL(matchers.EqModelsProjectCommandContext(ctx))).ThenReturn("url-to-project-jobs")
+		When(projectJobURLGenerator.GenerateProjectJobURL(matchers.EqModelsProjectCommandContext(ctx))).ThenReturn("url-to-project-jobs", nil)
 		err := prjCmdOutputHandler.SetJobURLWithStatus(ctx, models.PlanCommand, models.PendingCommitStatus)
 		Ok(t, err)
 
 		projectStatusUpdater.VerifyWasCalledOnce().UpdateProject(ctx, models.PlanCommand, models.PendingCommitStatus, "url-to-project-jobs")
 	})
+
+	t.Run("update project status with project jobs url error", func(t *testing.T) {
+		RegisterMockTestingT(t)
+		logger := logging.NewNoopLogger(t)
+		prjCmdOutputChan := make(chan *models.ProjectCmdOutputLine)
+		projectStatusUpdater := mocks.NewMockProjectStatusUpdater()
+		projectJobURLGenerator := mocks.NewMockProjectJobURLGenerator()
+		prjCmdOutputHandler := handlers.NewAsyncProjectCommandOutputHandler(
+			prjCmdOutputChan,
+			projectStatusUpdater,
+			projectJobURLGenerator,
+			logger,
+		)
+
+		When(projectJobURLGenerator.GenerateProjectJobURL(matchers.EqModelsProjectCommandContext(ctx))).ThenReturn("url-to-project-jobs", errors.New("some error"))
+		err := prjCmdOutputHandler.SetJobURLWithStatus(ctx, models.PlanCommand, models.PendingCommitStatus)
+		assert.Error(t, err)
+	})
 }
 
 func TestFeatureAwareOutputHandler(t *testing.T) {

server/router.go

@@ -5,6 +5,7 @@ import (
 	"net/url"
 
 	"github.com/gorilla/mux"
+	"github.com/pkg/errors"
 	"github.com/runatlantis/atlantis/server/events/models"
 )
 
@@ -38,14 +39,19 @@ func (r *Router) GenerateLockURL(lockID string) string {
 	return r.AtlantisURL.String() + lockURL.String()
 }
 
-func (r *Router) GenerateProjectJobURL(ctx models.ProjectCommandContext) string {
+func (r *Router) GenerateProjectJobURL(ctx models.ProjectCommandContext) (string, error) {
 	pull := ctx.Pull
 
-	jobURL, _ := r.Underlying.Get(r.ProjectJobsViewRouteName).URL(
+	jobURL, err := r.Underlying.Get(r.ProjectJobsViewRouteName).URL(
 		"org", pull.BaseRepo.Owner,
 		"repo", pull.BaseRepo.Name,
 		"pull", fmt.Sprintf("%d", pull.Num),
 		"project", ctx.ProjectName,
 	)
-	return r.AtlantisURL.String() + jobURL.String()
+
+	if err != nil {
+		return "", errors.Wrapf(err, "creating job url for %s/%d/%s", pull.BaseRepo.FullName, pull.Num, ctx.ProjectName)
+	}
+
+	return r.AtlantisURL.String() + jobURL.String(), nil
 }