backend/plugins/gitlab/api/blueprint_V200_test.go

/*
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements.  See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You 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 api

import (
	"testing"

	coreModels "github.com/apache/incubator-devlake/core/models"
	mockplugin "github.com/apache/incubator-devlake/mocks/core/plugin"

	"github.com/apache/incubator-devlake/core/models/common"
	"github.com/apache/incubator-devlake/core/plugin"
	"github.com/apache/incubator-devlake/helpers/pluginhelper/api"
	"github.com/apache/incubator-devlake/helpers/srvhelper"
	"github.com/apache/incubator-devlake/plugins/gitlab/models"
	"github.com/apache/incubator-devlake/plugins/gitlab/tasks"
	"github.com/stretchr/testify/assert"
)

func mockGitlabPlugin(t *testing.T) {
	mockMeta := mockplugin.NewPluginMeta(t)
	mockMeta.On("RootPkgPath").Return("github.com/apache/incubator-devlake/plugins/gitlab")
	mockMeta.On("Name").Return("dummy").Maybe()
	err := plugin.RegisterPlugin(pluginName, mockMeta)
	assert.Equal(t, err, nil)
}

func TestMakeScopes(t *testing.T) {
	mockGitlabPlugin(t)

	const connectionId = 1
	const gitlabProjectId = 37
	const expectDomainScopeId = "gitlab:GitlabProject:1:37"

	actualScopes, err := makeScopeV200(
		connectionId,
		[]*srvhelper.ScopeDetail[models.GitlabProject, models.GitlabScopeConfig]{
			{
				Scope: models.GitlabProject{
					Scope: common.Scope{
						ConnectionId: connectionId,
					},
					GitlabId: gitlabProjectId,
				},
				ScopeConfig: &models.GitlabScopeConfig{
					ScopeConfig: common.ScopeConfig{
						Entities: []string{plugin.DOMAIN_TYPE_CODE, plugin.DOMAIN_TYPE_TICKET, plugin.DOMAIN_TYPE_CICD},
					},
				},
			},
		},
	)
	assert.Nil(t, err)
	assert.Equal(t, 3, len(actualScopes))
	assert.Equal(t, actualScopes[0].ScopeId(), expectDomainScopeId)
	assert.Equal(t, actualScopes[1].ScopeId(), expectDomainScopeId)
	assert.Equal(t, actualScopes[2].ScopeId(), expectDomainScopeId)
}

func TestMakeDataSourcePipelinePlanV200(t *testing.T) {
	mockGitlabPlugin(t)

	const connectionID uint64 = 1
	const gitlabProjectId = 37
	const scopeConfigId uint64 = 2
	const scopeConfigName string = "gitlab scope config"
	const gitlabEndPoint string = "https://gitlab.com/api/v4/"
	const httpUrlToRepo string = "https://this_is_cloneUrl"
	const gitlabToken string = "nddtf"
	const gitlabProjectName string = "gitlab-test"
	const pathWithNamespace string = "nddtf/gitlab-test"
	const expectDomainScopeId = "gitlab:GitlabProject:1:37"

	scopeConfig := &models.GitlabScopeConfig{
		ScopeConfig: common.ScopeConfig{
			Entities: []string{plugin.DOMAIN_TYPE_CODE, plugin.DOMAIN_TYPE_TICKET, plugin.DOMAIN_TYPE_CICD},
		},
		PrType: "hey,man,wasup",
		Refdiff: map[string]interface{}{
			"tagsPattern": "pattern",
			"tagsLimit":   10,
			"tagsOrder":   "reverse semver",
		},
	}

	actualPlans, err := makePipelinePlanV200(
		[]plugin.SubTaskMeta{
			tasks.ConvertProjectMeta,
			tasks.CollectApiIssuesMeta,
			tasks.ExtractApiIssuesMeta,
			tasks.ConvertIssuesMeta,
			tasks.ConvertIssueLabelsMeta,
			tasks.CollectApiJobsMeta,
			tasks.ExtractApiJobsMeta,
			tasks.CollectApiPipelinesMeta,
			tasks.ExtractApiPipelinesMeta,
		},
		&models.GitlabConnection{
			BaseConnection: api.BaseConnection{
				Model: common.Model{
					ID: connectionID,
				},
			},
			GitlabConn: models.GitlabConn{
				RestConnection: api.RestConnection{},
				AccessToken: api.AccessToken{
					Token: gitlabToken,
				},
			},
		},
		[]*srvhelper.ScopeDetail[models.GitlabProject, models.GitlabScopeConfig]{
			{
				Scope: models.GitlabProject{
					GitlabId:          gitlabProjectId,
					Name:              gitlabProjectName,
					PathWithNamespace: pathWithNamespace,
					HttpUrlToRepo:     httpUrlToRepo,
				},
				ScopeConfig: scopeConfig,
			},
		},
	)
	assert.Nil(t, err)

	var expectPlans = coreModels.PipelinePlan{
		{
			{
				Plugin: pluginName,
				Subtasks: []string{
					tasks.ConvertProjectMeta.Name,
					tasks.CollectApiIssuesMeta.Name,
					tasks.ExtractApiIssuesMeta.Name,
					tasks.ConvertIssuesMeta.Name,
					tasks.ConvertIssueLabelsMeta.Name,
					tasks.CollectApiJobsMeta.Name,
					tasks.ExtractApiJobsMeta.Name,
					tasks.CollectApiPipelinesMeta.Name,
					tasks.ExtractApiPipelinesMeta.Name,
				},
				Options: map[string]interface{}{
					"connectionId": connectionID,
					"projectId":    gitlabProjectId,
					"fullName":     pathWithNamespace,
				},
			},
			{
				Plugin: "gitextractor",
				Options: map[string]interface{}{
					"proxy":    "",
					"repoId":   expectDomainScopeId,
					"name":     gitlabProjectName,
					"fullName": pathWithNamespace,
					"url":      "https://git:nddtf@this_is_cloneUrl",
				},
			},
		},
		{
			{
				Plugin: "refdiff",
				Options: map[string]interface{}{
					"tagsLimit":   10,
					"tagsOrder":   "reverse semver",
					"tagsPattern": "pattern",
				},
			},
		},
	}

	assert.Equal(t, expectPlans, actualPlans)
}

func Test_makePipelinePlanV200_with_empty_scope_config(t *testing.T) {

	mockGitlabPlugin(t)

	type args struct {
		subtaskMetas []plugin.SubTaskMeta
		connection   *models.GitlabConnection
		scopeDetails []*srvhelper.ScopeDetail[models.GitlabProject, models.GitlabScopeConfig]
	}

	tests := []struct {
		name                      string
		args                      args
		makeSureGitExtractorExist bool
		wantError                 bool
	}{
		{
			name: "without-empty-scope-config",
			args: args{
				subtaskMetas: []plugin.SubTaskMeta{},
				scopeDetails: []*srvhelper.ScopeDetail[models.GitlabProject, models.GitlabScopeConfig]{
					&srvhelper.ScopeDetail[models.GitlabProject, models.GitlabScopeConfig]{
						Scope:       models.GitlabProject{},
						ScopeConfig: &models.GitlabScopeConfig{},
					},
				},
				connection: &models.GitlabConnection{
					BaseConnection: api.BaseConnection{
						Model: common.Model{
							ID: 1,
						},
					},
					GitlabConn: models.GitlabConn{},
				},
			},
			makeSureGitExtractorExist: true,
			wantError:                 false,
		},
	}
	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			got, got1 := makePipelinePlanV200(tt.args.subtaskMetas, tt.args.connection, tt.args.scopeDetails)
			if tt.wantError {
				assert.Equalf(t, nil, got1, "makePipelinePlanV200 want error(%v, %v, %v)", tt.args.subtaskMetas, tt.args.scopeDetails, tt.args.connection)
			}
			if tt.makeSureGitExtractorExist {
				var existGitExtractor bool
				for _, g := range got {
					for _, v := range g {
						if v.Plugin == "gitextractor" {
							existGitExtractor = true
						}
					}
				}
				if !existGitExtractor {
					t.Fatal("gitextractor not found")
				}
			}
		})
	}
}