fix: ensure cloning workingdir before calling plan api

[terakoya76]

what

Fix #2949 by cloning the working dir before processing plan/apply api call.

why

As reported in #2949, when calling plan/apply from api, if the target workingdir has not been cloned by atlantis, an error occurs and plan/apply cannot be performed.

Specifically, if an error is returned when executing the buildProjectPlanCommand method GetWorkingDir, the event reported in Issue.

atlantis/server/events/project_command_builder.go

Line 459 in b6466bd

defaultRepoDir, err := p.WorkingDir.GetWorkingDir(ctx.Pull.BaseRepo, ctx.Pull, DefaultWorkspace)

This makes it particularly difficult to execute plan/api from a lifecycle outside of a pull request. This patch allows developers to use the api to build drift detection mechanisms, etc.

tests

Added unit tests.

And locally tested with the payload like this.

curl -X POST -H 'X-Atlantis-Token: mysecret' -H 'Content-Type: application/json' 'http://localhost:4141/api/plan' -d '{
  "Type": "Github",
  "Repository": "myorg/myrepo",
  "Ref": "main",
  "Projects": ["test"],
  "Paths": [{
    "Workspace": "test",
    "Directory": "./"
  }]
}'

references

• closes /api/plan does not create workspace if it does not exist #2949

[terakoya76]

#2465 introduced a lock for each PR, but the release of the lock appears to have been omitted.

[terakoya76]

Ready to be reviewed.

[terakoya76]

Although the failing check seems irrelevant to my change, should I take some actions?

[jamengual]

@GenPage

[MichaelKora]

@terakoya76 any updates here?

[GenPage]

I will be reviewing this week

[GenPage]

I did review this, but I have some reservations about introducing another "Clone" while we are still trying to figure out clones and project locks in #3345.

We will internally discuss further within the maintainer team.

[rgs1]

FWIW, testing this internally along with #3985 plus atlantis-drift-detection seems to working for us. We'll put some load on it and see if it's reliable.

[rgs1]

We've been using for more than a few months now, still looking good.

[GenPage]

@runatlantis/core-contributors please review

[X-Guardian]

@terakoya76, can you resolve the conflicts on this?

[github-actions]

This issue is stale because it has been open for 1 month with no activity. Remove stale label or comment or this will be closed in 1 month.

[jamengual]

@terakoya76, could you sign the commits to give this another review?

[terakoya76]

Thanks for all the coordination.
I will add the signoff message to past commits.

[terakoya76]

I failed to leave recent merge commits in place and only sign off messages on past commits.
As a result, the merge commits disappeared. Sorry about that.
But the contents should be the same.

[jamengual]

@terakoya76 could you check the status checks? some of them are failing