diff --git a/cmd/server.go b/cmd/server.go
index ad07254e4..e3367b999 100644
--- a/cmd/server.go
+++ b/cmd/server.go
@@ -1005,30 +1005,31 @@ func (s *ServerCmd) securityWarnings(userConfig *server.UserConfig) {
// being used. Right now this only applies to flags that have been made obsolete
// due to server-side config.
func (s *ServerCmd) deprecationWarnings(userConfig *server.UserConfig) error {
- var applyReqs []string
+ var commandReqs []string
var deprecatedFlags []string
if userConfig.RequireApproval {
deprecatedFlags = append(deprecatedFlags, RequireApprovalFlag)
- applyReqs = append(applyReqs, valid.ApprovedApplyReq)
+ commandReqs = append(commandReqs, valid.ApprovedCommandReq)
}
if userConfig.RequireMergeable {
deprecatedFlags = append(deprecatedFlags, RequireMergeableFlag)
- applyReqs = append(applyReqs, valid.MergeableApplyReq)
+ commandReqs = append(commandReqs, valid.MergeableCommandReq)
}
// Build up strings with what the recommended yaml and json config should
// be instead of using the deprecated flags.
yamlCfg := "---\nrepos:\n- id: /.*/"
jsonCfg := `{"repos":[{"id":"/.*/"`
- if len(applyReqs) > 0 {
- yamlCfg += fmt.Sprintf("\n apply_requirements: [%s]", strings.Join(applyReqs, ", "))
- jsonCfg += fmt.Sprintf(`, "apply_requirements":["%s"]`, strings.Join(applyReqs, "\", \""))
-
+ if len(commandReqs) > 0 {
+ yamlCfg += fmt.Sprintf("\n apply_requirements: [%s]", strings.Join(commandReqs, ", "))
+ yamlCfg += fmt.Sprintf("\n import_requirements: [%s]", strings.Join(commandReqs, ", "))
+ jsonCfg += fmt.Sprintf(`, "apply_requirements":["%s"]`, strings.Join(commandReqs, "\", \""))
+ jsonCfg += fmt.Sprintf(`, "import_requirements":["%s"]`, strings.Join(commandReqs, "\", \""))
}
if userConfig.AllowRepoConfig {
deprecatedFlags = append(deprecatedFlags, AllowRepoConfigFlag)
- yamlCfg += "\n allowed_overrides: [apply_requirements, workflow]\n allow_custom_workflows: true"
- jsonCfg += `, "allowed_overrides":["apply_requirements","workflow"], "allow_custom_workflows":true`
+ yamlCfg += "\n allowed_overrides: [apply_requirements, import_requirements, workflow]\n allow_custom_workflows: true"
+ jsonCfg += `, "allowed_overrides":["apply_requirements","import_requirements","workflow"], "allow_custom_workflows":true`
}
jsonCfg += "}]}"
diff --git a/runatlantis.io/.vuepress/config.js b/runatlantis.io/.vuepress/config.js
index 6f5943be3..e5410d5e2 100644
--- a/runatlantis.io/.vuepress/config.js
+++ b/runatlantis.io/.vuepress/config.js
@@ -74,7 +74,7 @@ module.exports = {
'custom-workflows',
'repo-level-atlantis-yaml',
'upgrading-atlantis-yaml',
- 'apply-requirements',
+ 'command-requirements',
'checkout-strategy',
'terraform-versions',
'terraform-cloud',
diff --git a/runatlantis.io/docs/apply-requirements.md b/runatlantis.io/docs/apply-requirements.md
index 4fa7edf3d..870ac4972 100644
--- a/runatlantis.io/docs/apply-requirements.md
+++ b/runatlantis.io/docs/apply-requirements.md
@@ -1,249 +1,5 @@
# Apply Requirements
-[[toc]]
-## Intro
-Atlantis allows you to require certain conditions be satisfied **before** an `atlantis apply`
-command can be run:
-
-* [Approved](#approved) – requires pull requests to be approved by at least one user other than the author
-* [Mergeable](#mergeable) – requires pull requests to be able to be merged
-* [UnDiverged](#undiverged) - requires pull requests to be ahead of the base branch
-
-## What Happens If The Requirement Is Not Met?
-If the requirement is not met, users will see an error if they try to run `atlantis apply`:
-
-
-## Supported Requirements
-### Approved
-The `approved` requirement will prevent applies unless the pull request is approved
-by at least one person other than the author.
-
-#### Usage
-You can set the `approved` requirement by:
-1. Passing the `--require-approval` flag to `atlantis server` or
-1. Creating a `repos.yaml` file with the `apply_requirements` key:
- ```yaml
- repos:
- - id: /.*/
- apply_requirements: [approved]
- ```
-1. Or by allowing an `atlantis.yaml` file to specify the `apply_requirements` key in your `repos.yaml` config:
- #### repos.yaml
- ```yaml
- repos:
- - id: /.*/
- allowed_overrides: [apply_requirements]
- ```
-
- #### atlantis.yaml
- ```yaml
- version: 3
- projects:
- - dir: .
- apply_requirements: [approved]
- ```
-
-#### Meaning
-Each VCS provider has different rules around who can approve:
-* **GitHub** – **Any user with read permissions** to the repo can approve a pull request
-* **GitLab** – You [can set](https://docs.gitlab.com/ee/user/project/merge_requests/merge_request_approvals.html) who is allowed to approve
-* **Bitbucket Cloud (bitbucket.org)** – A user can approve their own pull request but
- Atlantis does not count that as an approval and requires an approval from at least one user that
- is not the author of the pull request
-* **Azure DevOps** – **All builtin groups include the "Contribute to pull requests"** permission and can approve a pull request
-
-:::tip Tip
-If you want to require **certain people** to approve the pull request, look at the
-[mergeable](#mergeable) requirement.
+:::warning REDIRECT
+This page is moved to [Command Requirements](/docs/command-requirements.html).
:::
-
-### Mergeable
-The `mergeable` requirement will prevent applies unless a pull request is able to be merged.
-
-#### Usage
-You can set the `mergeable` requirement by:
-1. Passing the `--require-mergeable` flag to `atlantis server` or
-1. Creating a `repos.yaml` file with the `apply_requirements` key:
- ```yaml
- repos:
- - id: /.*/
- apply_requirements: [mergeable]
- ```
-
-1. Or by allowing an `atlantis.yaml` file to specify the `apply_requirements` key in your `repos.yaml` config:
- #### repos.yaml
- ```yaml
- repos:
- - id: /.*/
- allowed_overrides: [apply_requirements]
- ```
-
- #### atlantis.yaml
- ```yaml
- version: 3
- projects:
- - dir: .
- apply_requirements: [mergeable]
- ```
-
-#### Meaning
-Each VCS provider has a different concept of "mergeability":
-
-::: warning
-Some VCS providers have a feature for branch protection to control "mergeability". If you want to use it,
-you probably need to limit the base branch not to bypass the branch protection.
-See also the `branch` keyword in [Server Side Repo Config](server-side-repo-config.html#reference) for more details.
-:::
-
-#### GitHub
-In GitHub, if you're not using [Protected Branches](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches) then
-all pull requests are mergeable unless there is a conflict.
-
-If you set up Protected Branches then you can enforce:
-* Requiring certain status checks to be passing
-* Requiring certain people to have reviewed and approved the pull request
-* Requiring `CODEOWNERS` to have reviewed and approved the pull request
-* Requiring that the branch is up to date with `main`
-
-See [https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches)
-for more details.
-
-::: warning
-If you have the **Restrict who can push to this branch** requirement, then
-the Atlantis user needs to be part of that list in order for it to consider
-a pull request mergeable.
-:::
-
-::: warning
-If you set `atlantis/apply` to the mergeable requirement, use the `--gh-allow-mergeable-bypass-apply` flag or set the `ATLANTIS_GH_ALLOW_MERGEABLE_BYPASS_APPLY=true` environment variable. This flag and environment variable allow the mergeable check before executing `atlantis apply` to skip checking the status of `atlantis/apply`.
-:::
-
-#### GitLab
-For GitLab, a merge request will be merged if there are no conflicts, no unresolved discussions if it is a project requirement and if all necessary approvers have approved the pull request.
-
-For pipelines, if the project requires that pipelines must succeed, all builds except the apply command status will be checked.
-
-For Jobs with allow_failure setting set to true, will be ignored. If the pipeline has been skipped and the project allows merging, it will be marked as mergeable.
-
-#### Bitbucket.org (Bitbucket Cloud) and Bitbucket Server (Stash)
-For Bitbucket, we just check if there is a conflict that is preventing a
-merge. We don't check anything else because Bitbucket's API doesn't support it.
-
-If you need a specific check, please
-[open an issue](https://github.com/runatlantis/atlantis/issues/new).
-
-#### Azure DevOps
-In Azure DevOps, all pull requests are mergeable unless there is a conflict. You can set a pull request to "Complete" right away, or set "Auto-Complete", which will merge after all branch policies are met. See [Review code with pull requests](https://docs.microsoft.com/en-us/azure/devops/repos/git/pull-requests?view=azure-devops).
-
-[Branch policies](https://docs.microsoft.com/en-us/azure/devops/repos/git/branch-policies?view=azure-devops) can:
-* Require a minimum number of reviewers
-* Allow users to approve their own changes
-* Allow completion even if some reviewers vote "Waiting" or "Reject"
-* Reset code reviewer votes when there are new changes
-* Require a specific merge strategy (squash, rebase, etc.)
-
-::: warning
-At this time, the Azure DevOps client only supports merging using the default 'no fast-forward' strategy. Make sure your branch policies permit this type of merge.
-:::
-
-### UnDiverged
-Prevent applies if there are any changes on the base branch since the most recent plan.
-Applies to `merge` checkout strategy only.
-
-#### Usage
-You can set the `undiverged` requirement by:
-1. Creating a `repos.yaml` file with the `apply_requirements` key:
- ```yaml
- repos:
- - id: /.*/
- apply_requirements: [undiverged]
- ```
-1. Or by allowing an `atlantis.yaml` file to specify the `apply_requirements` key in your `repos.yaml` config:
- #### repos.yaml
- ```yaml
- repos:
- - id: /.*/
- allowed_overrides: [apply_requirements]
- ```
-
- #### atlantis.yaml
- ```yaml
- version: 3
- projects:
- - dir: .
- apply_requirements: [undiverged]
- ```
-#### Meaning
-The `merge` checkout strategy creates a temporary merge commit and runs the `plan` on the Atlantis local version of the PR
-source and destination branch. The local destination branch can become out of date since changes to the destination branch are not fetched
-if there are no changes to the source branch. `undiverged` enforces that Atlantis local version of main is up to date
-with remote so that the state of the source during the `apply` is identical to that if you were to merge the PR at that
-time.
-
-## Setting Apply Requirements
-As mentioned above, you can set apply requirements via flags, in `repos.yaml`, or in `atlantis.yaml` if `repos.yaml`
-allows the override.
-
-### Flags Override
-Flags **override** any `repos.yaml` or `atlantis.yaml` settings so they are equivalent to always
-having that apply requirement set.
-
-### Project-Specific Settings
-If you only want some projects/repos to have apply requirements, then you must
-1. Not set the `--require-approval` or `--require-mergeable` flags, since those
- will override any `repos.yaml` or `atlantis.yaml` settings
-1. Specifying which repos have which requirements via the `repos.yaml` file.
- ```yaml
- repos:
- - id: /.*/
- apply_requirements: [approved]
- # Regex that defaults all repos to requiring approval
- - id: /github.com/runatlantis/.*/
- # Regex to match any repo under the atlantis namespace, and not require approval
- # except for repos that might match later in the chain
- apply_requirements: []
- - id: github.com/runatlantis/atlantis
- apply_requirements: [approved]
- # Exact string match of the github.com/runatlantis/atlantis repo
- # that sets apply_requirements to approved
- ```
-
-1. Specify which projects have which requirements via an `atlantis.yaml` file, and allowing
- `apply_requirements` to be set in in `atlantis.yaml` by the server side `repos.yaml`
- config.
-
- For example if I have two directories, `staging` and `production`, I might use:
- #### repos.yaml
- ```yaml
- repos:
- - id: /.*/
- allowed_overrides: [apply_requirements]
- # Allow any repo to specify apply_requirements in atlantis.yaml
- ```
-
- #### atlantis.yaml
- ```yaml
- version: 3
- projects:
- - dir: staging
- # By default, apply_requirements is empty so this
- # isn't strictly necessary.
- apply_requirements: []
- - dir: production
- # This requirement will only apply to the
- # production directory.
- apply_requirements: [mergeable]
-
-
-### Multiple Requirements
-You can set any or all of `approved`, `mergeable`, and `undiverged` requirements.
-
-## Who Can Apply?
-Once the apply requirement is satisfied, **anyone** that can comment on the pull
-request can run the actual `atlantis apply` command.
-
-## Next Steps
-* For more information on GitHub pull request reviews and approvals see: [https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)
-* For more information on GitLab merge request reviews and approvals (only supported on GitLab Enterprise) see: [https://docs.gitlab.com/ee/user/project/merge_requests/merge_request_approvals.html](https://docs.gitlab.com/ee/user/project/merge_requests/merge_request_approvals.html).
-* For more information on Bitbucket pull request reviews and approvals see: [https://confluence.atlassian.com/bitbucket/pull-requests-and-code-review-223220593.html](https://confluence.atlassian.com/bitbucket/pull-requests-and-code-review-223220593.html)
-* For more information on Azure DevOps pull request reviews and approvals see: [https://docs.microsoft.com/en-us/azure/devops/repos/git/pull-requests?view=azure-devops&tabs=browser](https://docs.microsoft.com/en-us/azure/devops/repos/git/pull-requests?view=azure-devops&tabs=browser)
diff --git a/runatlantis.io/docs/command-requirements.md b/runatlantis.io/docs/command-requirements.md
new file mode 100644
index 000000000..2620cc755
--- /dev/null
+++ b/runatlantis.io/docs/command-requirements.md
@@ -0,0 +1,257 @@
+# Command Requirements
+[[toc]]
+
+## Intro
+Atlantis requires certain conditions be satisfied **before** `atlantis apply` and `atlantis import`
+commands can be run:
+
+* [Approved](#approved) – requires pull requests to be approved by at least one user other than the author
+* [Mergeable](#mergeable) – requires pull requests to be able to be merged
+* [UnDiverged](#undiverged) - requires pull requests to be ahead of the base branch
+
+## What Happens If The Requirement Is Not Met?
+If the requirement is not met, users will see an error if they try to run `atlantis apply`:
+
+
+## Supported Requirements
+### Approved
+The `approved` requirement will prevent applies unless the pull request is approved
+by at least one person other than the author.
+
+#### Usage
+The `approved` requirement by:
+1. Passing the `--require-approval` flag to `atlantis server` or
+1. Creating a `repos.yaml` file with the `apply_requirements` key:
+ ```yaml
+ repos:
+ - id: /.*/
+ apply_requirements: [approved]
+ ```
+1. Or by allowing an `atlantis.yaml` file to specify the `apply_requirements` key in the `repos.yaml` config:
+ #### repos.yaml
+ ```yaml
+ repos:
+ - id: /.*/
+ allowed_overrides: [apply_requirements]
+ ```
+
+ #### atlantis.yaml
+ ```yaml
+ version: 3
+ projects:
+ - dir: .
+ apply_requirements: [approved]
+ ```
+
+#### Meaning
+Each VCS provider has different rules around who can approve:
+* **GitHub** – **Any user with read permissions** to the repo can approve a pull request
+* **GitLab** – The user who can approve can be set in the [repo settings](https://docs.gitlab.com/ee/user/project/merge_requests/merge_request_approvals.html)
+* **Bitbucket Cloud (bitbucket.org)** – A user can approve their own pull request but
+ Atlantis does not count that as an approval and requires an approval from at least one user that
+ is not the author of the pull request
+* **Azure DevOps** – **All builtin groups include the "Contribute to pull requests"** permission and can approve a pull request
+
+:::tip Tip
+To require **certain people** to approve the pull request, look at the
+[mergeable](#mergeable) requirement.
+:::
+
+### Mergeable
+The `mergeable` requirement will prevent applies unless a pull request is able to be merged.
+
+#### Usage
+Set the `mergeable` requirement by:
+1. Passing the `--require-mergeable` flag to `atlantis server` or
+1. Creating a `repos.yaml` file with the `apply_requirements` key:
+ ```yaml
+ repos:
+ - id: /.*/
+ apply_requirements: [mergeable]
+ ```
+
+1. Or by allowing an `atlantis.yaml` file to specify `apply_requirements` and `import_requirements` keys in the `repos.yaml` config:
+ #### repos.yaml
+ ```yaml
+ repos:
+ - id: /.*/
+ allowed_overrides: [apply_requirements, import_requirements]
+ ```
+
+ #### atlantis.yaml
+ ```yaml
+ version: 3
+ projects:
+ - dir: .
+ apply_requirements: [mergeable]
+ import_requirements: [mergeable]
+ ```
+
+#### Meaning
+Each VCS provider has a different concept of "mergeability":
+
+::: warning
+Some VCS providers have a feature for branch protection to control "mergeability". To use it,
+limit the base branch so to not bypass the branch protection.
+See also the `branch` keyword in [Server Side Repo Config](server-side-repo-config.html#reference) for more details.
+:::
+
+#### GitHub
+In GitHub, if you're not using [Protected Branches](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches) then
+all pull requests are mergeable unless there is a conflict.
+
+If you set up Protected Branches then you can enforce:
+* Requiring certain status checks to be passing
+* Requiring certain people to have reviewed and approved the pull request
+* Requiring `CODEOWNERS` to have reviewed and approved the pull request
+* Requiring that the branch is up to date with `main`
+
+See [https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches)
+for more details.
+
+::: warning
+If you have the **Restrict who can push to this branch** requirement, then
+the Atlantis user needs to be part of that list in order for it to consider
+a pull request mergeable.
+:::
+
+::: warning
+If you set `atlantis/apply` to the mergeable requirement, use the `--gh-allow-mergeable-bypass-apply` flag or set the `ATLANTIS_GH_ALLOW_MERGEABLE_BYPASS_APPLY=true` environment variable. This flag and environment variable allow the mergeable check before executing `atlantis apply` to skip checking the status of `atlantis/apply`.
+:::
+
+#### GitLab
+For GitLab, a merge request will be merged if there are no conflicts, no unresolved discussions if it is a project requirement and if all necessary approvers have approved the pull request.
+
+For pipelines, if the project requires that pipelines must succeed, all builds except the apply command status will be checked.
+
+For Jobs with allow_failure setting set to true, will be ignored. If the pipeline has been skipped and the project allows merging, it will be marked as mergeable.
+
+#### Bitbucket.org (Bitbucket Cloud) and Bitbucket Server (Stash)
+For Bitbucket, we just check if there is a conflict that is preventing a
+merge. We don't check anything else because Bitbucket's API doesn't support it.
+
+If you need a specific check, please
+[open an issue](https://github.com/runatlantis/atlantis/issues/new).
+
+#### Azure DevOps
+In Azure DevOps, all pull requests are mergeable unless there is a conflict. You can set a pull request to "Complete" right away, or set "Auto-Complete", which will merge after all branch policies are met. See [Review code with pull requests](https://docs.microsoft.com/en-us/azure/devops/repos/git/pull-requests?view=azure-devops).
+
+[Branch policies](https://docs.microsoft.com/en-us/azure/devops/repos/git/branch-policies?view=azure-devops) can:
+* Require a minimum number of reviewers
+* Allow users to approve their own changes
+* Allow completion even if some reviewers vote "Waiting" or "Reject"
+* Reset code reviewer votes when there are new changes
+* Require a specific merge strategy (squash, rebase, etc.)
+
+::: warning
+At this time, the Azure DevOps client only supports merging using the default 'no fast-forward' strategy. Make sure your branch policies permit this type of merge.
+:::
+
+### UnDiverged
+Prevent applies if there are any changes on the base branch since the most recent plan.
+Applies to `merge` checkout strategy only.
+
+#### Usage
+You can set the `undiverged` requirement by:
+1. Creating a `repos.yaml` file with `apply_requirements` and `import_requirements` keys:
+ ```yaml
+ repos:
+ - id: /.*/
+ apply_requirements: [undiverged]
+ import_requirements: [undiverged]
+ ```
+1. Or by allowing an `atlantis.yaml` file to specify the `apply_requirements` and `import_requirements` keys in your `repos.yaml` config:
+ #### repos.yaml
+ ```yaml
+ repos:
+ - id: /.*/
+ allowed_overrides: [apply_requirements, import_requirements]
+ ```
+
+ #### atlantis.yaml
+ ```yaml
+ version: 3
+ projects:
+ - dir: .
+ apply_requirements: [undiverged]
+ import_requirements: [undiverged]
+ ```
+#### Meaning
+The `merge` checkout strategy creates a temporary merge commit and runs the `plan` on the Atlantis local version of the PR
+source and destination branch. The local destination branch can become out of date since changes to the destination branch are not fetched
+if there are no changes to the source branch. `undiverged` enforces that Atlantis local version of main is up to date
+with remote so that the state of the source during the `apply` is identical to that if you were to merge the PR at that
+time.
+
+## Setting Command Requirements
+As mentioned above, you can set command requirements via flags, in `repos.yaml`, or in `atlantis.yaml` if `repos.yaml`
+allows the override.
+
+### Flags Override
+Flags **override** any `repos.yaml` or `atlantis.yaml` settings so they are equivalent to always
+having that apply requirement set.
+
+### Project-Specific Settings
+If you only want some projects/repos to have apply requirements, then you must
+1. Not set the `--require-approval` or `--require-mergeable` flags, since those
+ will override any `repos.yaml` or `atlantis.yaml` settings
+1. Specifying which repos have which requirements via the `repos.yaml` file.
+ ```yaml
+ repos:
+ - id: /.*/
+ apply_requirements: [approved]
+ import_requirements: [approved]
+ # Regex that defaults all repos to requiring approval
+ - id: /github.com/runatlantis/.*/
+ # Regex to match any repo under the atlantis namespace, and not require approval
+ # except for repos that might match later in the chain
+ apply_requirements: []
+ import_requirements: []
+ - id: github.com/runatlantis/atlantis
+ apply_requirements: [approved]
+ import_requirements: [approved]
+ # Exact string match of the github.com/runatlantis/atlantis repo
+ # that sets apply_requirements to approved
+ ```
+
+1. Specify which projects have which requirements via an `atlantis.yaml` file, and allowing
+ `apply_requirements` and `import_requirements` to be set in `atlantis.yaml` by the server side `repos.yaml`
+ config.
+
+ For example if I have two directories, `staging` and `production`, I might use:
+ #### repos.yaml
+ ```yaml
+ repos:
+ - id: /.*/
+ allowed_overrides: [apply_requirements, import_requirements]
+ # Allow any repo to specify apply_requirements in atlantis.yaml
+ ```
+
+ #### atlantis.yaml
+ ```yaml
+ version: 3
+ projects:
+ - dir: staging
+ # By default, apply_requirements and import_requirements are empty so this
+ # isn't strictly necessary.
+ apply_requirements: []
+ import_requirements: []
+ - dir: production
+ # This requirement will only apply to the
+ # production directory.
+ apply_requirements: [mergeable]
+ import_requirements: [mergeable]
+ ```
+
+### Multiple Requirements
+You can set any or all of `approved`, `mergeable`, and `undiverged` requirements.
+
+## Who Can Apply?
+Once the apply requirement is satisfied, **anyone** that can comment on the pull
+request can run the actual `atlantis apply` command.
+
+## Next Steps
+* For more information on GitHub pull request reviews and approvals see: [https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)
+* For more information on GitLab merge request reviews and approvals (only supported on GitLab Enterprise) see: [https://docs.gitlab.com/ee/user/project/merge_requests/merge_request_approvals.html](https://docs.gitlab.com/ee/user/project/merge_requests/merge_request_approvals.html).
+* For more information on Bitbucket pull request reviews and approvals see: [https://confluence.atlassian.com/bitbucket/pull-requests-and-code-review-223220593.html](https://confluence.atlassian.com/bitbucket/pull-requests-and-code-review-223220593.html)
+* For more information on Azure DevOps pull request reviews and approvals see: [https://docs.microsoft.com/en-us/azure/devops/repos/git/pull-requests?view=azure-devops&tabs=browser](https://docs.microsoft.com/en-us/azure/devops/repos/git/pull-requests?view=azure-devops&tabs=browser)
diff --git a/runatlantis.io/docs/custom-workflows.md b/runatlantis.io/docs/custom-workflows.md
index 25d6d4a5e..88a608713 100644
--- a/runatlantis.io/docs/custom-workflows.md
+++ b/runatlantis.io/docs/custom-workflows.md
@@ -47,6 +47,15 @@ workflows:
- init
- plan:
extra_args: ["-var-file", "production.tfvars"]
+ apply:
+ steps:
+ - apply:
+ extra_args: ["-var-file", "production.tfvars"]
+ import:
+ steps:
+ - init
+ - import:
+ extra_args: ["-var-file", "production.tfvars"]
```
Then in your repo-level `atlantis.yaml` file, you would reference the workflows:
```yaml
@@ -364,12 +373,14 @@ projects:
```yaml
plan:
apply:
+import:
```
-| Key | Type | Default | Required | Description |
-|-------|-----------------|-----------------------|----------|--------------------------------|
-| plan | [Stage](#stage) | `steps: [init, plan]` | no | How to plan for this project. |
-| apply | [Stage](#stage) | `steps: [apply]` | no | How to apply for this project. |
+| Key | Type | Default | Required | Description |
+|--------|-----------------|-------------------------|----------|----------------------------------|
+| plan | [Stage](#stage) | `steps: [init, plan]` | no | How to plan for this project. |
+| apply | [Stage](#stage) | `steps: [apply]` | no | How to apply for this project. |
+| import | [Stage](#stage) | `steps: [init, import]` | no | How to import for this project. |
### Stage
```yaml
@@ -385,16 +396,17 @@ steps:
| steps | array[[Step](#step)] | `[]` | no | List of steps for this stage. If the steps key is empty, no steps will be run for this stage. |
### Step
-#### Built-In Commands: init, plan, apply
+#### Built-In Commands
Steps can be a single string for a built-in command.
```yaml
- init
- plan
- apply
+- import
```
-| Key | Type | Default | Required | Description |
-| --------------- | ------ | ------- | -------- | ------------------------------------------------------------------------------------------------------ |
-| init/plan/apply | string | none | no | Use a built-in command without additional configuration. Only `init`, `plan` and `apply` are supported |
+| Key | Type | Default | Required | Description |
+|------------------------|--------|---------|----------|------------------------------------------------------------------------------------------------------------------|
+| init/plan/apply/import | string | none | no | Use a built-in command without additional configuration. Only `init`, `plan`, `apply` and `import` are supported |
#### Built-In Command With Extra Args
A map from string to `extra_args` for a built-in command with extra arguments.
@@ -405,10 +417,12 @@ A map from string to `extra_args` for a built-in command with extra arguments.
extra_args: [arg1, arg2]
- apply:
extra_args: [arg1, arg2]
+- import:
+ extra_args: [arg1, arg2]
```
-| Key | Type | Default | Required | Description |
-|-----------------|------------------------------------|---------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------|
-| init/plan/apply | map[`extra_args` -> array[string]] | none | no | Use a built-in command and append `extra_args`. Only `init`, `plan` and `apply` are supported as keys and only `extra_args` is supported as a value |
+| Key | Type | Default | Required | Description |
+|------------------------|------------------------------------|---------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| init/plan/apply/import | map[`extra_args` -> array[string]] | none | no | Use a built-in command and append `extra_args`. Only `init`, `plan`, `apply` and `import` are supported as keys and only `extra_args` is supported as a value |
#### Custom `run` Command
Or a custom command
diff --git a/runatlantis.io/docs/policy-checking.md b/runatlantis.io/docs/policy-checking.md
index 3be38a1ad..9bea65c50 100644
--- a/runatlantis.io/docs/policy-checking.md
+++ b/runatlantis.io/docs/policy-checking.md
@@ -10,7 +10,7 @@ for using this step include:
## How it works?
-Enabling "policy checking" in addition to the [mergeable apply requirement](https://www.runatlantis.io/docs/apply-requirements.html#supported-requirements) blocks applies on plans that fail any of the defined conftest policies.
+Enabling "policy checking" in addition to the [mergeable apply requirement](/docs/command-requirements.html#supported-requirements) blocks applies on plans that fail any of the defined conftest policies.
diff --git a/runatlantis.io/docs/repo-level-atlantis-yaml.md b/runatlantis.io/docs/repo-level-atlantis-yaml.md
index c596855ba..ca7d27354 100644
--- a/runatlantis.io/docs/repo-level-atlantis-yaml.md
+++ b/runatlantis.io/docs/repo-level-atlantis-yaml.md
@@ -60,7 +60,8 @@ projects:
autoplan:
when_modified: ["*.tf", "../modules/**/*.tf"]
enabled: true
- apply_requirements: [mergeable, approved]
+ apply_requirements: [mergeable, approved, undiverged]
+ import_requirements: [mergeable, approved, undiverged]
workflow: myworkflow
workflows:
myworkflow:
@@ -215,10 +216,11 @@ projects:
- dir: staging
- dir: production
apply_requirements: [approved]
+ import_requirements: [approved]
```
:::warning
-`apply_requirements` is a restricted key so this repo will need to be configured
-to be allowed to set this key. See [Server-Side Repo Config Use Cases](server-side-repo-config.html#repos-can-set-their-own-apply-requirements).
+`apply_requirements` and `import_requirements` are restricted keys so this repo will need to be configured
+to be allowed to set this key. See [Server-Side Repo Config Use Cases](server-side-repo-config.html#repos-can-set-their-own-apply-an-applicable-subcommand).
:::
### Order of planning/applying
@@ -269,22 +271,24 @@ repo_locking: true
autoplan:
terraform_version: 0.11.0
apply_requirements: ["approved"]
+import_requirements: ["approved"]
workflow: myworkflow
```
-| Key | Type | Default | Required | Description |
-|----------------------------------------|-----------------------|-------------|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| name | string | none | maybe | Required if there is more than one project with the same `dir` and `workspace`. This project name can be used with the `-p` flag. |
-| branch | string | none | no | Regex matching projects by the base branch of pull request (the branch the pull request is getting merged into). Only projects that match the PR's branch will be considered. By default, all branches are matched. |
-| dir | string | none | **yes** | The directory of this project relative to the repo root. For example if the project was under `./project1` then use `project1`. Use `.` to indicate the repo root. |
-| workspace | string | `"default"` | no | The [Terraform workspace](https://developer.hashicorp.com/terraform/language/state/workspaces) for this project. Atlantis will switch to this workplace when planning/applying and will create it if it doesn't exist. |
-| execution_order_group | int | `0` | no | Index of execution order group. Projects will be sort by this field before planning/applying. |
-| delete_source_branch_on_merge | bool | `false` | no | Automatically deletes the source branch on merge. |
-| repo_locking | bool | `true` | no | Get a repository lock in this project when plan. |
-| autoplan | [Autoplan](#autoplan) | none | no | A custom autoplan configuration. If not specified, will use the autoplan config. See [Autoplanning](autoplanning.html). |
-| terraform_version | string | none | no | A specific Terraform version to use when running commands for this project. Must be [Semver compatible](https://semver.org/), ex. `v0.11.0`, `0.12.0-beta1`. |
-| apply_requirements
*(restricted)* | array[string] | none | no | Requirements that must be satisfied before `atlantis apply` can be run. Currently the only supported requirements are `approved`, `mergeable`, and `undiverged`. See [Apply Requirements](apply-requirements.html) for more details. |
-| workflow
*(restricted)* | string | none | no | A custom workflow. If not specified, Atlantis will use its default workflow. |
+| Key | Type | Default | Required | Description |
+|------------------------------------------|-----------------------|-------------|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| name | string | none | maybe | Required if there is more than one project with the same `dir` and `workspace`. This project name can be used with the `-p` flag. |
+| branch | string | none | no | Regex matching projects by the base branch of pull request (the branch the pull request is getting merged into). Only projects that match the PR's branch will be considered. By default, all branches are matched. |
+| dir | string | none | **yes** | The directory of this project relative to the repo root. For example if the project was under `./project1` then use `project1`. Use `.` to indicate the repo root. |
+| workspace | string | `"default"` | no | The [Terraform workspace](https://developer.hashicorp.com/terraform/language/state/workspaces) for this project. Atlantis will switch to this workplace when planning/applying and will create it if it doesn't exist. |
+| execution_order_group | int | `0` | no | Index of execution order group. Projects will be sort by this field before planning/applying. |
+| delete_source_branch_on_merge | bool | `false` | no | Automatically deletes the source branch on merge. |
+| repo_locking | bool | `true` | no | Get a repository lock in this project when plan. |
+| autoplan | [Autoplan](#autoplan) | none | no | A custom autoplan configuration. If not specified, will use the autoplan config. See [Autoplanning](autoplanning.html). |
+| terraform_version | string | none | no | A specific Terraform version to use when running commands for this project. Must be [Semver compatible](https://semver.org/), ex. `v0.11.0`, `0.12.0-beta1`. |
+| apply_requirements
*(restricted)* | array[string] | none | no | Requirements that must be satisfied before `atlantis apply` can be run. Currently the only supported requirements are `approved`, `mergeable`, and `undiverged`. See [Command Requirements](command-requirements.html) for more details. |
+| import_requirements
*(restricted)* | array[string] | none | no | Requirements that must be satisfied before `atlantis import` can be run. Currently the only supported requirements are `approved`, `mergeable`, and `undiverged`. See [Command Requirements](command-requirements.html) for more details. |
+| workflow
*(restricted)* | string | none | no | A custom workflow. If not specified, Atlantis will use its default workflow. |
::: tip
A project represents a Terraform state. Typically, there is one state per directory and workspace however it's possible to
diff --git a/runatlantis.io/docs/server-configuration.md b/runatlantis.io/docs/server-configuration.md
index 8e2a1a97e..ba67914dc 100644
--- a/runatlantis.io/docs/server-configuration.md
+++ b/runatlantis.io/docs/server-configuration.md
@@ -505,9 +505,9 @@ and set `--autoplan-modules` to `false`.
### `--gh-team-allowlist`
```bash
- atlantis server --gh-team-allowlist="myteam:plan, secteam:apply, DevOps Team:apply"
+ atlantis server --gh-team-allowlist="myteam:plan, secteam:apply, DevOps Team:apply, DevOps Team:import"
# or
- ATLANTIS_GH_TEAM_ALLOWLIST="myteam:plan, secteam:apply, DevOps Team:apply"
+ ATLANTIS_GH_TEAM_ALLOWLIST="myteam:plan, secteam:apply, DevOps Team:apply, DevOps Team:import"
```
In versions v0.21.0 and later, the GitHub team name can be a name or a slug.
@@ -789,7 +789,7 @@ and set `--autoplan-modules` to `false`.
ATLANTIS_REQUIRE_APPROVAL=true
```
This flag is deprecated. It requires all pull requests to be approved
- before `atlantis apply` is allowed. See [Apply Requirements](apply-requirements.html) for more details.
+ before `atlantis apply` is allowed. See [Command Requirements](command-requirements.html) for more details.
Instead of using this flag, create a server-side `--repo-config` file:
```yaml
@@ -808,7 +808,7 @@ and set `--autoplan-modules` to `false`.
ATLANTIS_REQUIRE_MERGEABLE=true
```
This flag is deprecated. It causes all pull requests to be mergeable
- before `atlantis apply` is allowed. See [Apply Requirements](apply-requirements.html) for more details.
+ before `atlantis apply` is allowed. See [Command Requirements](command-requirements.html) for more details.
Instead of using this flag, create a server-side `--repo-config` file:
```yaml
diff --git a/runatlantis.io/docs/server-side-repo-config.md b/runatlantis.io/docs/server-side-repo-config.md
index 025df2c9e..5bf6205ac 100644
--- a/runatlantis.io/docs/server-side-repo-config.md
+++ b/runatlantis.io/docs/server-side-repo-config.md
@@ -40,7 +40,10 @@ repos:
repo_config_file: path/to/atlantis.yaml
# apply_requirements sets the Apply Requirements for all repos that match.
- apply_requirements: [approved, mergeable]
+ apply_requirements: [approved, mergeable, undiverged]
+
+ # import_requirements sets the Import Requirements for all repos that match.
+ import_requirements: [approved, mergeable, undiverged]
# workflow sets the workflow for all repos that match.
# This workflow must be defined in the workflows section.
@@ -97,9 +100,9 @@ workflows:
## Use Cases
Here are some of the reasons you might want to use a repo config.
-### Requiring PR Is Approved Before Apply
+### Requiring PR Is Approved Before an applicable subcommand
If you want to require that all (or specific) repos must have pull requests
-approved before Atlantis will allow running `apply`, use the `apply_requirements` key.
+approved before Atlantis will allow running `apply` or `import`, use the `apply_requirements` or `import_requirements` keys.
For all repos:
```yaml
@@ -107,6 +110,7 @@ For all repos:
repos:
- id: /.*/
apply_requirements: [approved]
+ import_requirements: [approved]
```
For a specific repo:
@@ -115,13 +119,14 @@ For a specific repo:
repos:
- id: github.com/myorg/myrepo
apply_requirements: [approved]
+ import_requirements: [approved]
```
-See [Apply Requirements](apply-requirements.html) for more details.
+See [Command Requirements](command-requirements.html) for more details.
-### Requiring PR Is "Mergeable" Before Apply
+### Requiring PR Is "Mergeable" Before Apply or Import
If you want to require that all (or specific) repos must have pull requests
-in a mergeable state before Atlantis will allow running `apply`, use the `apply_requirements` key.
+in a mergeable state before Atlantis will allow running `apply` or `import`, use the `apply_requirements` or `import_requirements` keys.
For all repos:
```yaml
@@ -129,6 +134,7 @@ For all repos:
repos:
- id: /.*/
apply_requirements: [mergeable]
+ import_requirements: [mergeable]
```
For a specific repo:
@@ -137,11 +143,12 @@ For a specific repo:
repos:
- id: github.com/myorg/myrepo
apply_requirements: [mergeable]
+ import_requirements: [mergeable]
```
-See [Apply Requirements](apply-requirements.html) for more details.
+See [Command Requirements](command-requirements.html) for more details.
-### Repos Can Set Their Own Apply Requirements
+### Repos Can Set Their Own Apply an applicable subcommand
If you want all (or specific) repos to be able to override the default apply requirements, use
the `allowed_overrides` key.
@@ -152,9 +159,10 @@ repos:
- id: /.*/
# The default will be approved.
apply_requirements: [approved]
+ import_requirements: [approved]
# But all repos can set their own using atlantis.yaml
- allowed_overrides: [apply_requirements]
+ allowed_overrides: [apply_requirements, import_requirements]
```
To allow only a specific repo to override the default:
```yaml
@@ -163,20 +171,22 @@ repos:
# Set a default for all repos.
- id: /.*/
apply_requirements: [approved]
+ import_requirements: [approved]
# Allow a specific repo to override.
- id: github.com/myorg/myrepo
- allowed_overrides: [apply_requirements]
+ allowed_overrides: [apply_requirements, import_requirements]
```
Then each allowed repo can have an `atlantis.yaml` file that
-sets `apply_requirements` to an empty array (disabling the requirement).
+sets `apply_requirements` or `import_requirements` to an empty array (disabling the requirement).
```yaml
# atlantis.yaml in the repo root or set repo_config_file in repos.yaml
version: 3
projects:
- dir: .
apply_requirements: []
+ import_requirements: []
```
### Running Scripts Before Atlantis Workflows
@@ -427,6 +437,7 @@ repos:
- id: /.*/
branch: /.*/
apply_requirements: []
+ import_requirements: []
workflow: default
allowed_overrides: []
allow_custom_workflows: false
@@ -454,7 +465,8 @@ If you set a workflow with the key `default`, it will override this.
| branch | string | none | no | An regex matching pull requests by base branch (the branch the pull request is getting merged into). By default, all branches are matched |
| repo_config_file | string | none | no | Repo config file path in this repo. By default, use `atlantis.yaml` which is located on repository root. When multiple atlantis servers work with the same repo, please set different file names. |
| workflow | string | none | no | A custom workflow. |
-| apply_requirements | []string | none | no | Requirements that must be satisfied before `atlantis apply` can be run. Currently the only supported requirements are `approved`, `mergeable`, and `undiverged`. See [Apply Requirements](apply-requirements.html) for more details. |
+| apply_requirements | []string | none | no | Requirements that must be satisfied before `atlantis apply` can be run. Currently the only supported requirements are `approved`, `mergeable`, and `undiverged`. See [Command Requirements](command-requirements.html) for more details. |
+| import_requirements | []string | none | no | Requirements that must be satisfied before `atlantis import` can be run. Currently the only supported requirements are `approved`, `mergeable`, and `undiverged`. See [Command Requirements](command-requirements.html) for more details. |
| allowed_overrides | []string | none | no | A list of restricted keys that `atlantis.yaml` files can override. The only supported keys are `apply_requirements`, `workflow`, `delete_source_branch_on_merge` and `repo_locking` |
| allowed_workflows | []string | none | no | A list of workflows that `atlantis.yaml` files can select from. |
| allow_custom_workflows | bool | false | no | Whether or not to allow [Custom Workflows](custom-workflows.html). |
diff --git a/runatlantis.io/docs/using-atlantis.md b/runatlantis.io/docs/using-atlantis.md
index e2a78ca3f..ca43da7c9 100644
--- a/runatlantis.io/docs/using-atlantis.md
+++ b/runatlantis.io/docs/using-atlantis.md
@@ -63,7 +63,7 @@ atlantis plan -w staging
* `-d directory` Which directory to run plan in relative to root of repo. Use `.` for root.
* Ex. `atlantis plan -d child/dir`
* `-p project` Which project to run plan for. Refers to the name of the project configured in the repo's [`atlantis.yaml` file](repo-level-atlantis-yaml.html). Cannot be used at same time as `-d` or `-w` because the project defines this already.
-* `-w workspace` Switch to this [Terraform workspace](https://developer.hashicorp.com/terraform/language/state/workspaces) before planning. Defaults to `default`. If not using Terraform workspaces you can ignore this.
+* `-w workspace` Switch to this [Terraform workspace](https://developer.hashicorp.com/terraform/language/state/workspaces) before planning. Defaults to `default`. Ignore this if Terraform workspaces are unused.
* `--verbose` Append Atlantis log to comment.
::: warning NOTE
@@ -72,7 +72,7 @@ A `atlantis plan` (without flags), like autoplans, discards all plans previously
### Additional Terraform flags
-If you need to run `terraform plan` with additional arguments, like `-target=resource` or `-var 'foo-bar'` or `-var-file myfile.tfvars`
+If `terraform plan` requires additional arguments, like `-target=resource` or `-var 'foo=bar'` or `-var-file myfile.tfvars`
you can append them to the end of the comment after `--`, ex.
```
atlantis plan -d dir -- -var foo='bar'
@@ -110,7 +110,7 @@ atlantis apply -w staging
### Options
* `-d directory` Apply the plan for this directory, relative to root of repo. Use `.` for root.
* `-p project` Apply the plan for this project. Refers to the name of the project configured in the repo's [`atlantis.yaml` file](repo-level-atlantis-yaml.html). Cannot be used at same time as `-d` or `-w`.
-* `-w workspace` Apply the plan for this [Terraform workspace](https://developer.hashicorp.com/terraform/language/state/workspaces). If not using Terraform workspaces you can ignore this.
+* `-w workspace` Apply the plan for this [Terraform workspace](https://developer.hashicorp.com/terraform/language/state/workspaces). Ignore this if Terraform workspaces are unused.
* `--auto-merge-disabled` Disable [automerge](automerging.html) for this apply command.
* `--verbose` Append Atlantis log to comment.
@@ -124,6 +124,49 @@ Because Atlantis under the hood is running `terraform apply plan.tfplan`, any Te
They're ignored because they can't be specified for an already generated planfile.
If you would like to specify these flags, do it while running `atlantis plan`.
+---
+## atlantis import
+```bash
+atlantis import [options] ADDRESS ID -- [terraform import flags]
+```
+### Explanation
+Runs `terraform import` that matches the directory/project/workspace.
+This command discards the terraform plan result. After an import and before an apply, another `atlantis plan` must be run again.
+
+### Examples
+```bash
+# Runs import
+atlantis import ADDRESS ID
+
+# Runs import in the root directory of the repo with workspace `default`
+atlantis import -d . ADDRESS ID
+
+# Runs import in the `project1` directory of the repo with workspace `default`
+atlantis import -d project1 ADDRESS ID
+
+# Runs import in the root directory of the repo with workspace `staging`
+atlantis import -w staging ADDRESS ID
+```
+
+::: tip
+* If import for_each resources, it requires a single quoted address.
+ * ex. `atlantis import 'aws_instance.example["foo"]' i-1234567890abcdef0`
+:::
+
+### Options
+* `-d directory` Import a resource for this directory, relative to root of repo. Use `.` for root.
+* `-p project` Import a resource for this project. Refers to the name of the project configured in the repo's [`atlantis.yaml`](repo-level-atlantis-yaml.html) repo configuration file. This cannot be used at the same time as `-d` or `-w`.
+* `-w workspace` Import a resource for a specific [Terraform workspace](https://developer.hashicorp.com/terraform/language/state/workspaces). Ignore this if Terraform workspaces are unused.
+
+### Additional Terraform flags
+
+If `terraform import` requires additional arguments, like `-var 'foo=bar'` or `-var-file myfile.tfvars`
+append them to the end of the comment after `--`, e.g.
+```
+atlantis import -d dir 'aws_instance.example["foo"]' i-1234567890abcdef0 -- -var foo='bar'
+```
+If a flag is needed to be always appended, see [Custom Workflow Use Cases](custom-workflows.html#adding-extra-arguments-to-terraform-commands).
+
---
## atlantis unlock
```bash
diff --git a/server/controllers/api_controller_test.go b/server/controllers/api_controller_test.go
index 8cae678b6..1ba56d02f 100644
--- a/server/controllers/api_controller_test.go
+++ b/server/controllers/api_controller_test.go
@@ -3,8 +3,6 @@ package controllers_test
import (
"bytes"
"encoding/json"
- "github.com/runatlantis/atlantis/server/events/command"
- "github.com/runatlantis/atlantis/server/events/models"
"net/http"
"net/http/httptest"
"testing"
@@ -13,8 +11,10 @@ import (
"github.com/runatlantis/atlantis/server/controllers"
. "github.com/runatlantis/atlantis/server/core/locking/mocks"
"github.com/runatlantis/atlantis/server/events"
+ "github.com/runatlantis/atlantis/server/events/command"
. "github.com/runatlantis/atlantis/server/events/mocks"
. "github.com/runatlantis/atlantis/server/events/mocks/matchers"
+ "github.com/runatlantis/atlantis/server/events/models"
. "github.com/runatlantis/atlantis/server/events/vcs/mocks"
"github.com/runatlantis/atlantis/server/logging"
"github.com/runatlantis/atlantis/server/metrics"
diff --git a/server/controllers/events/events_controller_e2e_test.go b/server/controllers/events/events_controller_e2e_test.go
index 717286af8..1ecb43b8c 100644
--- a/server/controllers/events/events_controller_e2e_test.go
+++ b/server/controllers/events/events_controller_e2e_test.go
@@ -2,6 +2,7 @@ package events_test
import (
"bytes"
+ "encoding/json"
"fmt"
"net/http"
"net/http/httptest"
@@ -406,6 +407,62 @@ func TestGitHubWorkflow(t *testing.T) {
{"exp-output-merge.txt"},
},
},
+ {
+ Description: "import single project",
+ RepoDir: "import-single-project",
+ ModifiedFiles: []string{"main.tf"},
+ ExpAutoplan: true,
+ Comments: []string{
+ "atlantis import random_id.dummy1 AA",
+ "atlantis apply",
+ "atlantis import random_id.dummy2 BB",
+ "atlantis plan",
+ },
+ ExpReplies: [][]string{
+ {"exp-output-autoplan.txt"},
+ {"exp-output-import-dummy1.txt"},
+ {"exp-output-apply-no-projects.txt"},
+ {"exp-output-import-dummy2.txt"},
+ {"exp-output-plan-again.txt"},
+ {"exp-output-merge.txt"},
+ },
+ },
+ {
+ Description: "import single project with -var",
+ RepoDir: "import-single-project-var",
+ ModifiedFiles: []string{"main.tf"},
+ ExpAutoplan: true,
+ Comments: []string{
+ "atlantis import 'random_id.for_each[\"overridden\"]' AA -- -var var=overridden",
+ "atlantis import random_id.count[0] BB",
+ "atlantis plan -- -var var=overridden",
+ },
+ ExpReplies: [][]string{
+ {"exp-output-autoplan.txt"},
+ {"exp-output-import-foreach.txt"},
+ {"exp-output-import-count.txt"},
+ {"exp-output-plan-again.txt"},
+ {"exp-output-merge.txt"},
+ },
+ },
+ {
+ Description: "import multiple project",
+ RepoDir: "import-multiple-project",
+ ModifiedFiles: []string{"dir1/main.tf", "dir2/main.tf"},
+ ExpAutoplan: true,
+ Comments: []string{
+ "atlantis import random_id.dummy1 AA",
+ "atlantis import -d dir1 random_id.dummy1 AA",
+ "atlantis plan",
+ },
+ ExpReplies: [][]string{
+ {"exp-output-autoplan.txt"},
+ {"exp-output-import-multiple-projects.txt"},
+ {"exp-output-import-dummy1.txt"},
+ {"exp-output-plan-again.txt"},
+ {"exp-output-merge.txt"},
+ },
+ },
}
for _, c := range cases {
t.Run(c.Description, func(t *testing.T) {
@@ -1041,6 +1098,10 @@ func setupE2E(t *testing.T, repoDir, repoConfigFile string) (events_controllers.
ApplyStepRunner: &runtime.ApplyStepRunner{
TerraformExecutor: terraformClient,
},
+ ImportStepRunner: &runtime.ImportStepRunner{
+ TerraformExecutor: terraformClient,
+ DefaultTFVersion: defaultTFVersion,
+ },
RunStepRunner: &runtime.RunStepRunner{
TerraformExecutor: terraformClient,
DefaultTFVersion: defaultTFVersion,
@@ -1049,7 +1110,7 @@ func setupE2E(t *testing.T, repoDir, repoConfigFile string) (events_controllers.
WorkingDir: workingDir,
Webhooks: &mockWebhookSender{},
WorkingDirLocker: locker,
- AggregateApplyRequirements: &events.AggregateApplyRequirements{
+ CommandRequirementHandler: &events.DefaultCommandRequirementHandler{
WorkingDir: workingDir,
},
}
@@ -1142,12 +1203,19 @@ func setupE2E(t *testing.T, repoDir, repoConfigFile string) (events_controllers.
silenceNoProjects,
)
+ importCommandRunner := events.NewImportCommandRunner(
+ pullUpdater,
+ projectCommandBuilder,
+ projectCommandRunner,
+ )
+
commentCommandRunnerByCmd := map[command.Name]events.CommentCommandRunner{
command.Plan: planCommandRunner,
command.Apply: applyCommandRunner,
command.ApprovePolicies: approvePoliciesCommandRunner,
command.Unlock: unlockCommandRunner,
command.Version: versionCommandRunner,
+ command.Import: importCommandRunner,
}
commandRunner := &events.DefaultCommandRunner{
@@ -1211,7 +1279,9 @@ func (w *mockWebhookSender) Send(log logging.SimpleLogging, result webhooks.Appl
func GitHubCommentEvent(t *testing.T, comment string) *http.Request {
requestJSON, err := os.ReadFile(filepath.Join("testfixtures", "githubIssueCommentEvent.json"))
Ok(t, err)
- requestJSON = []byte(strings.Replace(string(requestJSON), "###comment body###", comment, 1))
+ escapedComment, err := json.Marshal(comment)
+ Ok(t, err)
+ requestJSON = []byte(strings.Replace(string(requestJSON), "\"###comment body###\"", string(escapedComment), 1))
req, err := http.NewRequest("POST", "/events", bytes.NewBuffer(requestJSON))
Ok(t, err)
req.Header.Set("Content-Type", "application/json")
diff --git a/server/controllers/events/testfixtures/test-repos/import-multiple-project/atlantis.yaml b/server/controllers/events/testfixtures/test-repos/import-multiple-project/atlantis.yaml
new file mode 100644
index 000000000..006db31ba
--- /dev/null
+++ b/server/controllers/events/testfixtures/test-repos/import-multiple-project/atlantis.yaml
@@ -0,0 +1,4 @@
+version: 3
+projects:
+- dir: dir1
+- dir: dir2
diff --git a/server/controllers/events/testfixtures/test-repos/import-multiple-project/dir1/main.tf b/server/controllers/events/testfixtures/test-repos/import-multiple-project/dir1/main.tf
new file mode 100644
index 000000000..2aa6a6437
--- /dev/null
+++ b/server/controllers/events/testfixtures/test-repos/import-multiple-project/dir1/main.tf
@@ -0,0 +1,4 @@
+resource "random_id" "dummy1" {
+ keepers = {}
+ byte_length = 1
+}
diff --git a/server/controllers/events/testfixtures/test-repos/import-multiple-project/dir2/main.tf b/server/controllers/events/testfixtures/test-repos/import-multiple-project/dir2/main.tf
new file mode 100644
index 000000000..5292f29c8
--- /dev/null
+++ b/server/controllers/events/testfixtures/test-repos/import-multiple-project/dir2/main.tf
@@ -0,0 +1,4 @@
+resource "random_id" "dummy2" {
+ keepers = {}
+ byte_length = 1
+}
diff --git a/server/controllers/events/testfixtures/test-repos/import-multiple-project/exp-output-autoplan.txt b/server/controllers/events/testfixtures/test-repos/import-multiple-project/exp-output-autoplan.txt
new file mode 100644
index 000000000..7c1465751
--- /dev/null
+++ b/server/controllers/events/testfixtures/test-repos/import-multiple-project/exp-output-autoplan.txt
@@ -0,0 +1,81 @@
+Ran Plan for 2 projects:
+
+1. dir: `dir1` workspace: `default`
+1. dir: `dir2` workspace: `default`
+
+### 1. dir: `dir1` workspace: `default`
+Show Output
+
+```diff
+
+Terraform used the selected providers to generate the following execution
+plan. Resource actions are indicated with the following symbols:
++ create
+
+Terraform will perform the following actions:
+
+ # random_id.dummy1 will be created
++ resource "random_id" "dummy1" {
+ + b64_std = (known after apply)
+ + b64_url = (known after apply)
+ + byte_length = 1
+ + dec = (known after apply)
+ + hex = (known after apply)
+ + id = (known after apply)
+ + keepers = {}
+ }
+
+Plan: 1 to add, 0 to change, 0 to destroy.
+
+
+```
+
+* :arrow_forward: To **apply** this plan, comment:
+ * `atlantis apply -d dir1`
+* :put_litter_in_its_place: To **delete** this plan click [here](lock-url)
+* :repeat: To **plan** this project again, comment:
+ * `atlantis plan -d dir1`
+Show Output
+
+```diff
+
+Terraform used the selected providers to generate the following execution
+plan. Resource actions are indicated with the following symbols:
++ create
+
+Terraform will perform the following actions:
+
+ # random_id.dummy2 will be created
++ resource "random_id" "dummy2" {
+ + b64_std = (known after apply)
+ + b64_url = (known after apply)
+ + byte_length = 1
+ + dec = (known after apply)
+ + hex = (known after apply)
+ + id = (known after apply)
+ + keepers = {}
+ }
+
+Plan: 1 to add, 0 to change, 0 to destroy.
+
+
+```
+
+* :arrow_forward: To **apply** this plan, comment:
+ * `atlantis apply -d dir2`
+* :put_litter_in_its_place: To **delete** this plan click [here](lock-url)
+* :repeat: To **plan** this project again, comment:
+ * `atlantis plan -d dir2`
+Show Output
+
+```diff
+
+Terraform used the selected providers to generate the following execution
+plan. Resource actions are indicated with the following symbols:
++ create
+
+Terraform will perform the following actions:
+
+ # random_id.dummy2 will be created
++ resource "random_id" "dummy2" {
+ + b64_std = (known after apply)
+ + b64_url = (known after apply)
+ + byte_length = 1
+ + dec = (known after apply)
+ + hex = (known after apply)
+ + id = (known after apply)
+ + keepers = {}
+ }
+
+Plan: 1 to add, 0 to change, 0 to destroy.
+
+
+```
+
+* :arrow_forward: To **apply** this plan, comment:
+ * `atlantis apply -d dir2`
+* :put_litter_in_its_place: To **delete** this plan click [here](lock-url)
+* :repeat: To **plan** this project again, comment:
+ * `atlantis plan -d dir2`
+Show Output
+
+```diff
+
+Terraform used the selected providers to generate the following execution
+plan. Resource actions are indicated with the following symbols:
++ create
+
+Terraform will perform the following actions:
+
+ # random_id.count[0] will be created
++ resource "random_id" "count" {
+ + b64_std = (known after apply)
+ + b64_url = (known after apply)
+ + byte_length = 1
+ + dec = (known after apply)
+ + hex = (known after apply)
+ + id = (known after apply)
+ + keepers = {}
+ }
+
+ # random_id.for_each["default"] will be created
++ resource "random_id" "for_each" {
+ + b64_std = (known after apply)
+ + b64_url = (known after apply)
+ + byte_length = 1
+ + dec = (known after apply)
+ + hex = (known after apply)
+ + id = (known after apply)
+ + keepers = {}
+ }
+
+Plan: 2 to add, 0 to change, 0 to destroy.
+
+
+```
+
+* :arrow_forward: To **apply** this plan, comment:
+ * `atlantis apply -d .`
+* :put_litter_in_its_place: To **delete** this plan click [here](lock-url)
+* :repeat: To **plan** this project again, comment:
+ * `atlantis plan -d .`
+Show Output
+
+```diff
+
+Terraform used the selected providers to generate the following execution
+plan. Resource actions are indicated with the following symbols:
++ create
+
+Terraform will perform the following actions:
+
+ # random_id.dummy1 will be created
++ resource "random_id" "dummy1" {
+ + b64_std = (known after apply)
+ + b64_url = (known after apply)
+ + byte_length = 1
+ + dec = (known after apply)
+ + hex = (known after apply)
+ + id = (known after apply)
+ + keepers = {}
+ }
+
+ # random_id.dummy2 will be created
++ resource "random_id" "dummy2" {
+ + b64_std = (known after apply)
+ + b64_url = (known after apply)
+ + byte_length = 1
+ + dec = (known after apply)
+ + hex = (known after apply)
+ + id = (known after apply)
+ + keepers = {}
+ }
+
+Plan: 2 to add, 0 to change, 0 to destroy.
+
+
+```
+
+* :arrow_forward: To **apply** this plan, comment:
+ * `atlantis apply -d .`
+* :put_litter_in_its_place: To **delete** this plan click [here](lock-url)
+* :repeat: To **plan** this project again, comment:
+ * `atlantis plan -d .`
+Show Output
+```diff
+{{.Output}}
+```
+