forked from GoogleCloudPlatform/terraformer
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add gitlab provider (GoogleCloudPlatform#1006)
* Add import gitlab_project * Heredoc for project variable and ignore `mirror` fields in projects * Be more specific in the IgnoreKeys * Disable heredoc * Add project's BranchProtections TagProtections ProjectMembership * Add group's GroupVariables GroupMembership * Add docs * Update docs * Remove invalid test * Fix golangci-lint * Fix golangci-lint
- Loading branch information
Showing
10 changed files
with
587 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| // Copyright 2018 The Terraformer Authors. | ||
| // | ||
| // 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. | ||
| package cmd | ||
|
|
||
| import ( | ||
| "log" | ||
| "strings" | ||
|
|
||
| gitLab_terraforming "github.com/GoogleCloudPlatform/terraformer/providers/gitlab" | ||
| "github.com/GoogleCloudPlatform/terraformer/terraformutils" | ||
| "github.com/spf13/cobra" | ||
| ) | ||
|
|
||
| func newCmdGitLabImporter(options ImportOptions) *cobra.Command { | ||
| token := "" | ||
| baseURL := "" | ||
| groups := []string{} | ||
| cmd := &cobra.Command{ | ||
| Use: "gitlab", | ||
| Short: "Import current state to Terraform configuration from GitLab", | ||
| Long: "Import current state to Terraform configuration from GitLab", | ||
| RunE: func(cmd *cobra.Command, args []string) error { | ||
| originalPathPattern := options.PathPattern | ||
| for _, group := range groups { | ||
| provider := newGitLabProvider() | ||
| options.PathPattern = originalPathPattern | ||
| options.PathPattern = strings.ReplaceAll(options.PathPattern, "{provider}", "{provider}/"+group) | ||
| log.Println(provider.GetName() + " importing group " + group) | ||
| err := Import(provider, options, []string{group, token, baseURL}) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| } | ||
| return nil | ||
| }, | ||
| } | ||
| cmd.AddCommand(listCmd(newGitLabProvider())) | ||
| baseProviderFlags(cmd.PersistentFlags(), &options, "repository", "repository=id1:id2:id4") | ||
| cmd.PersistentFlags().StringVarP(&token, "token", "t", "", "YOUR_GITLAB_TOKEN or env param GITLAB_TOKEN") | ||
| cmd.PersistentFlags().StringSliceVarP(&groups, "group", "", []string{}, "paths to groups") | ||
| cmd.PersistentFlags().StringVarP(&baseURL, "base-url", "", "", "") | ||
| return cmd | ||
| } | ||
|
|
||
| func newGitLabProvider() terraformutils.ProviderGenerator { | ||
| return &gitLab_terraforming.GitLabProvider{} | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| ### Use with GitLab | ||
|
|
||
| Example: | ||
|
|
||
| ```shell | ||
| ./terraformer import gitlab --group=GROUP_TO_IMPORT --resources=projects --token=YOUR_TOKEN # or GITLAB_TOKEN in env | ||
| ./terraformer import gitlab --group=GROUP_TO_IMPORT --resources=groups --base-url=https://your-self-hosted-gitlab-domain/api/v4 | ||
| ``` | ||
|
|
||
| List of supported resources: | ||
|
|
||
| * `projects` | ||
| * `gitlab_project` | ||
| * `gitlab_project_value` | ||
| * `gitlab_project_membership` | ||
| * `gitlab_tag_protection` | ||
| * `gitlab_branch_protection` | ||
| * `groups` | ||
| * `gitlab_group_membership` | ||
| * `gitlab_group_variable` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,103 @@ | ||
| // Copyright 2018 The Terraformer Authors. | ||
| // | ||
| // 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. | ||
|
|
||
| package gitlab | ||
|
|
||
| import ( | ||
| "os" | ||
|
|
||
| "github.com/GoogleCloudPlatform/terraformer/terraformutils" | ||
| "github.com/pkg/errors" | ||
| "github.com/zclconf/go-cty/cty" | ||
| ) | ||
|
|
||
| type GitLabProvider struct { //nolint | ||
| terraformutils.Provider | ||
| group string | ||
| token string | ||
| baseURL string | ||
| } | ||
|
|
||
| func (p GitLabProvider) GetResourceConnections() map[string]map[string][]string { | ||
| return map[string]map[string][]string{} | ||
| } | ||
|
|
||
| func (p GitLabProvider) GetProviderData(arg ...string) map[string]interface{} { | ||
| return map[string]interface{}{ | ||
| "provider": map[string]interface{}{ | ||
| "gitlab": map[string]interface{}{ | ||
| // TODO: Should I add some default config here? | ||
| // "token": p.token, | ||
| // "base_url": p.baseURL, | ||
| }, | ||
| }, | ||
| } | ||
| } | ||
|
|
||
| func (p *GitLabProvider) GetConfig() cty.Value { | ||
| return cty.ObjectVal(map[string]cty.Value{ | ||
| "token": cty.StringVal(p.token), | ||
| // NOTE: Real provider doesn't support empty/null base_url, only set when there's value | ||
| "base_url": cty.StringVal(p.baseURL), | ||
| }) | ||
| } | ||
|
|
||
| // Init GitLabProvider with group | ||
| func (p *GitLabProvider) Init(args []string) error { | ||
| p.group = args[0] | ||
| p.baseURL = gitLabDefaultURL | ||
| if len(args) < 2 { | ||
| if os.Getenv("GITLAB_TOKEN") == "" { | ||
| return errors.New("token requirement") | ||
| } | ||
| p.token = os.Getenv("GITLAB_TOKEN") | ||
| } else { | ||
| p.token = args[1] | ||
| } | ||
| if len(args) > 2 { | ||
| if args[2] != "" { | ||
| p.baseURL = args[2] | ||
| } | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| func (p *GitLabProvider) GetName() string { | ||
| return "gitlab" | ||
| } | ||
|
|
||
| func (p *GitLabProvider) InitService(serviceName string, verbose bool) error { | ||
| var isSupported bool | ||
| if _, isSupported = p.GetSupportedService()[serviceName]; !isSupported { | ||
| return errors.New(p.GetName() + ": " + serviceName + " not supported service") | ||
| } | ||
| p.Service = p.GetSupportedService()[serviceName] | ||
| p.Service.SetName(serviceName) | ||
| p.Service.SetVerbose(verbose) | ||
| p.Service.SetProviderName(p.GetName()) | ||
| p.Service.SetArgs(map[string]interface{}{ | ||
| "group": p.group, | ||
| "token": p.token, | ||
| "base_url": p.baseURL, | ||
| }) | ||
| return nil | ||
| } | ||
|
|
||
| // GetSupportedService return map of support service for gitlab | ||
| func (p *GitLabProvider) GetSupportedService() map[string]terraformutils.ServiceGenerator { | ||
| return map[string]terraformutils.ServiceGenerator{ | ||
| "projects": &ProjectGenerator{}, | ||
| "groups": &GroupGenerator{}, | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| // Copyright 2018 The Terraformer Authors. | ||
| // | ||
| // 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. | ||
|
|
||
| package gitlab | ||
|
|
||
| import ( | ||
| "github.com/GoogleCloudPlatform/terraformer/terraformutils" | ||
| "github.com/xanzy/go-gitlab" | ||
| ) | ||
|
|
||
| const gitLabDefaultURL = "https://gitlab.com/api/v4/" | ||
|
|
||
| type GitLabService struct { //nolint | ||
| terraformutils.Service | ||
| } | ||
|
|
||
| func (g *GitLabService) createClient() (*gitlab.Client, error) { | ||
| if g.GetArgs()["base_url"].(string) == gitLabDefaultURL { | ||
| return g.createRegularClient() | ||
| } | ||
| return g.createEnterpriseClient() | ||
| } | ||
|
|
||
| func (g *GitLabService) createRegularClient() (*gitlab.Client, error) { | ||
| return gitlab.NewClient(g.Args["token"].(string)) | ||
| } | ||
|
|
||
| func (g *GitLabService) createEnterpriseClient() (*gitlab.Client, error) { | ||
| return gitlab.NewClient(g.Args["token"].(string), gitlab.WithBaseURL(g.GetArgs()["base_url"].(string))) | ||
| } |
Oops, something went wrong.