Files
atlantis/server/events/command_runner_test.go
Luke Kysow d3ec832eff WIP
2018-06-21 18:18:54 +01:00

240 lines
12 KiB
Go

// Copyright 2017 HootSuite Media Inc.
//
// Licensed 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.
// Modified hereafter by contributors to runatlantis/atlantis.
//
package events_test
import (
"bytes"
"log"
"testing"
. "github.com/petergtz/pegomock"
"github.com/runatlantis/atlantis/server/events"
"github.com/runatlantis/atlantis/server/events/mocks"
vcsmocks "github.com/runatlantis/atlantis/server/events/vcs/mocks"
logmocks "github.com/runatlantis/atlantis/server/logging/mocks"
//. "github.com/runatlantis/atlantis/testing"
)
var projectCommandBuilder *mocks.MockProjectCommandBuilder
var eventParsing *mocks.MockEventParsing
var vcsClient *vcsmocks.MockClientProxy
var ghStatus *mocks.MockCommitStatusUpdater
var githubGetter *mocks.MockGithubPullGetter
var gitlabGetter *mocks.MockGitlabMergeRequestGetter
var workspaceLocker *mocks.MockAtlantisWorkspaceLocker
var ch events.DefaultCommandRunner
var logBytes *bytes.Buffer
func setup(t *testing.T) {
RegisterMockTestingT(t)
projectCommandBuilder = mocks.NewMockProjectCommandBuilder()
eventParsing = mocks.NewMockEventParsing()
ghStatus = mocks.NewMockCommitStatusUpdater()
workspaceLocker = mocks.NewMockAtlantisWorkspaceLocker()
vcsClient = vcsmocks.NewMockClientProxy()
githubGetter = mocks.NewMockGithubPullGetter()
gitlabGetter = mocks.NewMockGitlabMergeRequestGetter()
logger := logmocks.NewMockSimpleLogging()
logBytes = new(bytes.Buffer)
When(logger.Underlying()).ThenReturn(log.New(logBytes, "", 0))
ch = events.DefaultCommandRunner{
VCSClient: vcsClient,
CommitStatusUpdater: ghStatus,
EventParser: eventParsing,
MarkdownRenderer: &events.MarkdownRenderer{},
GithubPullGetter: githubGetter,
GitlabMergeRequestGetter: gitlabGetter,
Logger: logger,
AllowForkPRs: false,
AllowForkPRsFlag: "allow-fork-prs-flag",
ProjectCommandBuilder: projectCommandBuilder,
}
}
//func TestExecuteCommand_LogPanics(t *testing.T) {
// t.Log("if there is a panic it is commented back on the pull request")
// setup(t)
// ch.AllowForkPRs = true // Lets us get to the panic code.
// defer func() { ch.AllowForkPRs = false }()
// When(ghStatus.Update(fixtures.GithubRepo, fixtures.Pull, vcs.Pending, events.Plan)).ThenPanic("panic")
// ch.RunCommentCommand(fixtures.GithubRepo, &fixtures.GithubRepo, fixtures.User, 1, nil)
// _, _, comment := vcsClient.VerifyWasCalledOnce().CreateComment(matchers.AnyModelsRepo(), AnyInt(), AnyString()).GetCapturedArguments()
// Assert(t, strings.Contains(comment, "Error: goroutine panic"), "comment should be about a goroutine panic")
//}
//
//func TestExecuteCommand_NoGithubPullGetter(t *testing.T) {
// t.Log("if DefaultCommandRunner was constructed with a nil GithubPullGetter an error should be logged")
// setup(t)
// ch.GithubPullGetter = nil
// ch.RunCommentCommand(fixtures.GithubRepo, &fixtures.GithubRepo, fixtures.User, 1, nil)
// Equals(t, "[ERROR] runatlantis/atlantis#1: Atlantis not configured to support GitHub\n", logBytes.String())
//}
//
//func TestExecuteCommand_NoGitlabMergeGetter(t *testing.T) {
// t.Log("if DefaultCommandRunner was constructed with a nil GitlabMergeRequestGetter an error should be logged")
// setup(t)
// ch.GitlabMergeRequestGetter = nil
// ch.RunCommentCommand(fixtures.GitlabRepo, &fixtures.GitlabRepo, fixtures.User, 1, nil)
// Equals(t, "[ERROR] runatlantis/atlantis#1: Atlantis not configured to support GitLab\n", logBytes.String())
//}
//
//func TestExecuteCommand_GithubPullErr(t *testing.T) {
// t.Log("if getting the github pull request fails an error should be logged")
// setup(t)
// When(githubGetter.GetPullRequest(fixtures.GithubRepo, fixtures.Pull.Num)).ThenReturn(nil, errors.New("err"))
// ch.RunCommentCommand(fixtures.GithubRepo, &fixtures.GithubRepo, fixtures.User, fixtures.Pull.Num, nil)
// Equals(t, "[ERROR] runatlantis/atlantis#1: Making pull request API call to GitHub: err\n", logBytes.String())
//}
//
//func TestExecuteCommand_GitlabMergeRequestErr(t *testing.T) {
// t.Log("if getting the gitlab merge request fails an error should be logged")
// setup(t)
// When(gitlabGetter.GetMergeRequest(fixtures.GithubRepo.FullName, fixtures.Pull.Num)).ThenReturn(nil, errors.New("err"))
// ch.RunCommentCommand(fixtures.GitlabRepo, &fixtures.GitlabRepo, fixtures.User, fixtures.Pull.Num, nil)
// Equals(t, "[ERROR] runatlantis/atlantis#1: Making merge request API call to GitLab: err\n", logBytes.String())
//}
//
//func TestExecuteCommand_GithubPullParseErr(t *testing.T) {
// t.Log("if parsing the returned github pull request fails an error should be logged")
// setup(t)
// var pull github.PullRequest
// When(githubGetter.GetPullRequest(fixtures.GithubRepo, fixtures.Pull.Num)).ThenReturn(&pull, nil)
// When(eventParsing.ParseGithubPull(&pull)).ThenReturn(fixtures.Pull, fixtures.GithubRepo, errors.New("err"))
//
// ch.RunCommentCommand(fixtures.GithubRepo, &fixtures.GithubRepo, fixtures.User, fixtures.Pull.Num, nil)
// Equals(t, "[ERROR] runatlantis/atlantis#1: Extracting required fields from comment data: err\n", logBytes.String())
//}
//
//func TestExecuteCommand_ForkPRDisabled(t *testing.T) {
// t.Log("if a command is run on a forked pull request and this is disabled atlantis should" +
// " comment saying that this is not allowed")
// setup(t)
// ch.AllowForkPRs = false // by default it's false so don't need to reset
// var pull github.PullRequest
// modelPull := models.PullRequest{State: models.Open}
// When(githubGetter.GetPullRequest(fixtures.GithubRepo, fixtures.Pull.Num)).ThenReturn(&pull, nil)
//
// headRepo := fixtures.GithubRepo
// headRepo.FullName = "forkrepo/atlantis"
// headRepo.Owner = "forkrepo"
// When(eventParsing.ParseGithubPull(&pull)).ThenReturn(modelPull, headRepo, nil)
//
// ch.RunCommentCommand(fixtures.GithubRepo, nil, fixtures.User, fixtures.Pull.Num, nil)
// vcsClient.VerifyWasCalledOnce().CreateComment(fixtures.GithubRepo, modelPull.Num, "Atlantis commands can't be run on fork pull requests. To enable, set --"+ch.AllowForkPRsFlag)
//}
//
//func TestExecuteCommand_ClosedPull(t *testing.T) {
// t.Log("if a command is run on a closed pull request atlantis should" +
// " comment saying that this is not allowed")
// setup(t)
// pull := &github.PullRequest{
// State: github.String("closed"),
// }
// modelPull := models.PullRequest{State: models.Closed}
// When(githubGetter.GetPullRequest(fixtures.GithubRepo, fixtures.Pull.Num)).ThenReturn(pull, nil)
// When(eventParsing.ParseGithubPull(pull)).ThenReturn(modelPull, fixtures.GithubRepo, nil)
//
// ch.RunCommentCommand(fixtures.GithubRepo, &fixtures.GithubRepo, fixtures.User, fixtures.Pull.Num, nil)
// vcsClient.VerifyWasCalledOnce().CreateComment(fixtures.GithubRepo, modelPull.Num, "Atlantis commands can't be run on closed pull requests")
//}
//
//func TestExecuteCommand_WorkspaceLocked(t *testing.T) {
// t.Log("if the workspace is locked, should comment back on the pull")
// setup(t)
// pull := &github.PullRequest{
// State: github.String("closed"),
// }
// cmd := events.CommentCommand{
// Name: events.Plan,
// Workspace: "workspace",
// }
//
// When(githubGetter.GetPullRequest(fixtures.GithubRepo, fixtures.Pull.Num)).ThenReturn(pull, nil)
// When(eventParsing.ParseGithubPull(pull)).ThenReturn(fixtures.Pull, fixtures.GithubRepo, nil)
// When(workspaceLocker.TryLock(fixtures.GithubRepo.FullName, cmd.Workspace, fixtures.Pull.Num)).ThenReturn(false)
// ch.RunCommentCommand(fixtures.GithubRepo, &fixtures.GithubRepo, fixtures.User, fixtures.Pull.Num, &cmd)
//
// msg := "The workspace workspace is currently locked by another" +
// " command that is running for this pull request." +
// " Wait until the previous command is complete and try again."
// ghStatus.VerifyWasCalledOnce().Update(fixtures.GithubRepo, fixtures.Pull, vcs.Pending, cmd.CommandName())
// _, _, result := ghStatus.VerifyWasCalledOnce().UpdateProjectResult(matchers.AnyPtrToEventsCommandContext(), matchers.AnyEventsCommandName(), matchers.AnyEventsCommandResult()).GetCapturedArguments()
// Equals(t, msg, result.Failure)
// vcsClient.VerifyWasCalledOnce().CreateComment(fixtures.GithubRepo, fixtures.Pull.Num,
// "**Plan Failed**: "+msg+"\n\n")
//}
//
//func TestExecuteCommand_FullRun(t *testing.T) {
// t.Log("when running a plan, apply should comment")
// pull := &github.PullRequest{
// State: github.String("closed"),
// }
// cmdResult := events.CommandResult{}
// for _, c := range []events.CommandName{events.Plan, events.Apply} {
// setup(t)
// cmd := events.CommentCommand{
// Name: c,
// Workspace: "workspace",
// }
// When(githubGetter.GetPullRequest(fixtures.GithubRepo, fixtures.Pull.Num)).ThenReturn(pull, nil)
// When(eventParsing.ParseGithubPull(pull)).ThenReturn(fixtures.Pull, fixtures.GithubRepo, nil)
// When(workspaceLocker.TryLock(fixtures.GithubRepo.FullName, cmd.Workspace, fixtures.Pull.Num)).ThenReturn(true)
// switch c {
// case events.Plan:
// When(projectCommandBuilder.PlanViaComment(matchers.AnyPtrToEventsCommandContext())).ThenReturn(cmdResult)
// case events.Apply:
// When(projectCommandBuilder.ApplyViaComment(matchers.AnyPtrToEventsCommandContext())).ThenReturn(cmdResult)
// }
//
// ch.RunCommentCommand(fixtures.GithubRepo, fixtures.GithubRepo, fixtures.User, fixtures.Pull.Num, &cmd)
//
// ghStatus.VerifyWasCalledOnce().Update(fixtures.GithubRepo, fixtures.Pull, vcs.Pending, &cmd)
// _, response := ghStatus.VerifyWasCalledOnce().UpdateProjectResult(matchers.AnyPtrToEventsCommandContext(), matchers.AnyEventsCommandResult()).GetCapturedArguments()
// Equals(t, cmdResult, response)
// vcsClient.VerifyWasCalledOnce().CreateComment(matchers.AnyModelsRepo(), AnyInt(), AnyString())
// workspaceLocker.VerifyWasCalledOnce().Unlock(fixtures.GithubRepo.FullName, cmd.Workspace, fixtures.Pull.Num)
// }
//}
//
//func TestExecuteCommand_ForkPREnabled(t *testing.T) {
// t.Log("when running a plan on a fork PR, it should succeed")
// setup(t)
//
// // Enable forked PRs.
// ch.AllowForkPRs = true
// defer func() { ch.AllowForkPRs = false }() // Reset after test.
//
// var pull github.PullRequest
// cmdResponse := events.CommandResult{}
// cmd := events.CommentCommand{
// Name: events.Plan,
// Workspace: "workspace",
// }
// When(githubGetter.GetPullRequest(fixtures.GithubRepo, fixtures.Pull.Num)).ThenReturn(&pull, nil)
// headRepo := fixtures.GithubRepo
// headRepo.FullName = "forkrepo/atlantis"
// headRepo.Owner = "forkrepo"
// When(eventParsing.ParseGithubPull(&pull)).ThenReturn(fixtures.Pull, headRepo, nil)
// When(workspaceLocker.TryLock(fixtures.GithubRepo.FullName, cmd.Workspace, fixtures.Pull.Num)).ThenReturn(true)
// When(projectCommandBuilder.PlanViaComment(matchers.AnyPtrToEventsCommandContext())).ThenReturn(cmdResponse)
//
// ch.RunCommentCommand(fixtures.GithubRepo, models.Repo{} /* this isn't used */, fixtures.User, fixtures.Pull.Num, &cmd)
//
// ghStatus.VerifyWasCalledOnce().Update(fixtures.GithubRepo, fixtures.Pull, vcs.Pending, &cmd)
// _, response := ghStatus.VerifyWasCalledOnce().UpdateProjectResult(matchers.AnyPtrToEventsCommandContext(), matchers.AnyEventsCommandResult()).GetCapturedArguments()
// Equals(t, cmdResponse, response)
// vcsClient.VerifyWasCalledOnce().CreateComment(matchers.AnyModelsRepo(), AnyInt(), AnyString())
// workspaceLocker.VerifyWasCalledOnce().Unlock(fixtures.GithubRepo.FullName, cmd.Workspace, fixtures.Pull.Num)
//}