Adding support for project templates

[ahmet2mir]

Hello,

I re-use the same test than initializereadme (no state).

use_custom_template, template_project_id and group_with_project_templates_id are EE features
template_name is EE and CE feature.

I see that Gitlab will took probably this repo control #376 so they probably rework all tests to split EE and CE.
We could use tags with go test but i'm not confortable with that and we have to change everywhere

So to simplify EE tests, I added an environment variable GITLAB_EE, when we enter in this test, it's skipped when not EE
(use SkipFunc: isRunningInCE)

on CE

=== RUN   TestAccGitlabProject_templateNameCustom
--- PASS: TestAccGitlabProject_templateNameCustom (0.00s)
=== RUN   TestAccGitlabProject_templateProjectID
--- PASS: TestAccGitlabProject_templateProjectID (0.00s)

In other hand, in start-gitlab, via rails, I:

• create a group
• create a template repo (simple git repo)
• declare the group as a template in admin settings

Thoses lines works with CE too (so I don't remove them, if in future Gitlab move thoses EE features to CE, we just have to remove the GITLAB_EE SkipFunc in tests)

And also migrate to go gitlab 0.37.0

[sfang97]

LGTM 🚀

[nicholasklick]

@armsnyder @roidelapluie if this is looking good can we get it merged?

[sfang97]

@ahmet2mir This needed a rebase so I went ahead and kept both changes (testAccGitlabProjectConfigTemplateName from this PR and testAccGitlabProjectConfigImportURL from master), WDYT?

[ahmet2mir]

LGTM :) Le lun. 14 sept. 2020 à 22:09, Serena Fang <[email protected]> a écrit :

…

@ahmet2mir <https://github.com/ahmet2mir> This needed a rebase so I went ahead and kept both changes (testAccGitlabProjectConfigTemplateName from this PR and testAccGitlabProjectConfigImportURL from master), WDYT? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#277 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ABZ2W7NGHCWCXVUBCPZS5QTSFZZ6FANCNFSM4LGHEDMQ> .

[sfang97]

The branch needed a rebase so I went ahead and rebased it, there was a small conflict that was easy to resolve (I kept both changes), which created a bunch of errors so I want to revert my merge. I'm getting this error though: " ! [remote rejected] project-template-support -> project-template-support (refusing to allow an OAuth App to create or update workflow .github/workflows/acceptance-tests.yml without workflow scope)
error: failed to push some refs to 'https://github.com/ahmet2mir/terraform-provider-gitlab'"
@ahmet2mir or someone else, could you revert my b6d5e38 commit? Sorry for messing with your branch 😅

[ahmet2mir]

I will recreate, too much conflicts and my changes are not so big. I did a push force to remove the binary from history and now we have too much commits.

[ahmet2mir]

Found how to test EE features, see PR comment.

[sfang97]

I will recreate, too much conflicts and my changes are not so big. I did a push force to remove the binary from history and now we have too much commits.

@ahmet2mir Thanks for reopening, sorry again for messing up your branch!

[armsnyder]

@ahmet2mir Do you need the new GITLAB_EE variable? In other EE-only tests we use SkipFunc: isRunningInCE as in here.

Also, I don't think we want to add any test-specific setup to the start-gitlab.sh file, because the tests should be able to run on existing GitLab instances. Can you create the template in the test code? TestAccGitlabProject_importURL is an example of how to add some custom setup logic.

[ahmet2mir]

@armsnyder I don't need the env var, SkipFunc: isRunningInCE is what I missed. thanks.

For start-gitlab.sh I didn't found another way to achieve this. This setting is defined in EE only and not available via API (or don't found it).

It's the param custom_project_templates_group_id, found on WEB https://gitlab.com/gitlab-org/gitlab/-/blob/master/ee/app/models/ee/application_setting.rb#L108 but not on API

I could only create the group, the project myrails based on rails, get the id and send to the tests but I can't change EE settings to declare the group as template.

client := testAccProvider.Meta().(*gitlab.Client)

// Create a base group for importing.
templateGroup, _, err := client.Groups.CreateGroup(&gitlab.CreateGroupOptions{
	Name:       gitlab.String(fmt.Sprintf("terraform-%d", rInt)),
	Path:       gitlab.String(fmt.Sprintf("terraform-%d", rInt)),
	Visibility: gitlab.Visibility(gitlab.PublicVisibility),
})
if err != nil {
	t.Fatalf("failed to create group template: %v", err)
}

// Create a template project based on rails called myrails.
baseProject, _, err := client.Projects.CreateProject(&gitlab.CreateProjectOptions{
	Name:         gitlab.String("myrails"),
	Visibility:   gitlab.Visibility(gitlab.PublicVisibility),
	TemplateName: gitlab.String("rails"),
})
if err != nil {
	t.Fatalf("failed to create template project: %v", err)
}

// Declare group as instance level template group
// not possible

[sfang97]

Thanks for your work on this @ahmet2mir, I've left a few comments.

[sfang97]

@ahmet2mir This looks good to me, thanks for working on it! Might be worth it to get another set of eyes on this before it goes in. @armsnyder Could you take a look? 😄

[armsnyder]

@ahmet2mir Thanks for the detailed response about the template group!

@roidelapluie What do you think about the change to start-gitlab.sh? Ahmet is using the rails console to configure the template project group, which is used in the test, because there's isn't a GitLab API for creating the template project group. (See the explanation here.) Since you know more about the ways tests can be run, do you think it's ok, or do you have any suggestions there?

@sfang97 Sure I'll review.

[armsnyder]

Also, just as a reminder @sfang97, we should run this PR from a branch of this repository, so that the EE tests can run, before we merge. I made the mistake of forgetting to do that recently and it was a pain to fix haha.

[ahmet2mir]

@armsnyder should be good now. Let me know if I forget something.
(and if it's ok I will squash commits)

[armsnyder]

lgtm! If you don't squash usually we will do it for you when we merge.

@roidelapluie What's your typical workflow for running EE tests? (Also see my earlier question about start-gitlab.sh)

[nicholasklick]

@ahmet2mir looks like one conflicting file and then we can get this merged.

[ahmet2mir]

@nicholasklick merged master to this branch

[ahmet2mir]

@armsnyder @sfang97 @roidelapluie I remerged and pushed forced changes due to lot of conflicts with master. Could we merge this or need I rebase everyday :)