backend/plugins/jenkins/impl/impl.go - incubator-devlake - Git at Google

 /*
 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 impl

 import (
 	"fmt"
 	"strings"
 	"time"

 	"github.com/apache/incubator-devlake/core/context"
 	"github.com/apache/incubator-devlake/core/dal"
 	"github.com/apache/incubator-devlake/core/models/domainlayer/devops"

 	"github.com/apache/incubator-devlake/core/errors"
 	"github.com/apache/incubator-devlake/core/plugin"
 	helper "github.com/apache/incubator-devlake/helpers/pluginhelper/api"
 	"github.com/apache/incubator-devlake/plugins/jenkins/api"
 	"github.com/apache/incubator-devlake/plugins/jenkins/models"
 	"github.com/apache/incubator-devlake/plugins/jenkins/models/migrationscripts"
 	"github.com/apache/incubator-devlake/plugins/jenkins/tasks"
 )

 var _ interface {
 	plugin.PluginMeta
 	plugin.PluginInit
 	plugin.PluginTask
 	plugin.PluginApi
 	plugin.PluginModel
 	plugin.PluginMigration
 	plugin.CloseablePluginTask
 	plugin.PluginSource
 	plugin.DataSourcePluginBlueprintV200
 } = (*Jenkins)(nil)

 type Jenkins struct{}

 func (p Jenkins) Init(basicRes context.BasicRes) errors.Error {
 	api.Init(basicRes, p)

 	return nil
 }

 func (p Jenkins) Connection() dal.Tabler {
 	return &models.JenkinsConnection{}
 }

 func (p Jenkins) Scope() plugin.ToolLayerScope {
 	return &models.JenkinsJob{}
 }

 func (p Jenkins) ScopeConfig() dal.Tabler {
 	return &models.JenkinsScopeConfig{}
 }

 func (p Jenkins) GetTablesInfo() []dal.Tabler {
 	return []dal.Tabler{
 		&models.JenkinsBuild{},
 		&models.JenkinsBuildCommit{},
 		&models.JenkinsConnection{},
 		&models.JenkinsJob{},
 		&models.JenkinsJobDag{},
 		&models.JenkinsStage{},
 		&models.JenkinsScopeConfig{},
 	}
 }

 func (p Jenkins) Description() string {
 	return "To collect and enrich data from Jenkins"
 }

 func (p Jenkins) Name() string {
 	return "jenkins"
 }

 func (p Jenkins) SubTaskMetas() []plugin.SubTaskMeta {
 	return []plugin.SubTaskMeta{
 		tasks.ConvertJobsMeta,
 		tasks.CollectApiBuildsMeta,
 		tasks.ExtractApiBuildsMeta,
 		tasks.CollectApiStagesMeta,
 		tasks.ExtractApiStagesMeta,
 		tasks.EnrichApiBuildWithStagesMeta,
 		tasks.ConvertBuildsToCicdTasksMeta,
 		tasks.ConvertStagesMeta,
 		tasks.ConvertBuildReposMeta,
 	}
 }
 func (p Jenkins) PrepareTaskData(taskCtx plugin.TaskContext, options map[string]interface{}) (interface{}, errors.Error) {
 	// Firstly, let's decode options to JenkinsOptions
 	op, err := tasks.DecodeTaskOptions(options)
 	if err != nil {
 		return nil, err
 	}

 	logger := taskCtx.GetLogger()
 	logger.Debug("%v", options)
 	connection := &models.JenkinsConnection{}
 	connectionHelper := helper.NewConnectionHelper(
 		taskCtx,
 		nil,
 		p.Name(),
 	)
 	if err != nil {
 		return nil, err
 	}
 	err = connectionHelper.FirstById(connection, op.ConnectionId)
 	if err != nil {
 		return nil, err
 	}

 	apiClient, err := tasks.CreateApiClient(taskCtx, connection)
 	if err != nil {
 		return nil, err
 	}

 	err = EnrichOptions(taskCtx, op, apiClient)
 	if err != nil {
 		return nil, err
 	}

 	var timeAfter time.Time
 	if op.TimeAfter != "" {
 		timeAfter, err = errors.Convert01(time.Parse(time.RFC3339, op.TimeAfter))
 		if err != nil {
 			return nil, errors.BadInput.Wrap(err, "invalid value for `timeAfter`")
 		}
 	}
 	regexEnricher := helper.NewRegexEnricher()
 	if err := regexEnricher.TryAdd(devops.DEPLOYMENT, op.ScopeConfig.DeploymentPattern); err != nil {
 		return nil, errors.BadInput.Wrap(err, "invalid value for `deploymentPattern`")
 	}
 	if err := regexEnricher.TryAdd(devops.PRODUCTION, op.ScopeConfig.ProductionPattern); err != nil {
 		return nil, errors.BadInput.Wrap(err, "invalid value for `productionPattern`")
 	}
 	taskData := &tasks.JenkinsTaskData{
 		Options:       op,
 		ApiClient:     apiClient,
 		Connection:    connection,
 		RegexEnricher: regexEnricher,
 	}
 	if !timeAfter.IsZero() {
 		taskData.TimeAfter = &timeAfter
 		logger.Debug("collect data created from %s", timeAfter)
 	}
 	return taskData, nil
 }

 func (p Jenkins) RootPkgPath() string {
 	return "github.com/apache/incubator-devlake/plugins/jenkins"
 }

 func (p Jenkins) MigrationScripts() []plugin.MigrationScript {
 	return migrationscripts.All()
 }

 func (p Jenkins) MakeDataSourcePipelinePlanV200(connectionId uint64, scopes []*plugin.BlueprintScopeV200, syncPolicy plugin.BlueprintSyncPolicy) (pp plugin.PipelinePlan, sc []plugin.Scope, err errors.Error) {
 	return api.MakeDataSourcePipelinePlanV200(p.SubTaskMetas(), connectionId, scopes, &syncPolicy)
 }

 func (p Jenkins) ApiResources() map[string]map[string]plugin.ApiResourceHandler {
 	return map[string]map[string]plugin.ApiResourceHandler{
 		"test": {
 			"POST": api.TestConnection,
 		},
 		"connections": {
 			"POST": api.PostConnections,
 			"GET":  api.ListConnections,
 		},
 		"connections/:connectionId": {
 			"PATCH":  api.PatchConnection,
 			"DELETE": api.DeleteConnection,
 			"GET":    api.GetConnection,
 		},
 		"connections/:connectionId/remote-scopes": {
 			"GET": api.RemoteScopes,
 		},
 		"connections/:connectionId/search-remote-scopes": {
 			"GET": api.SearchRemoteScopes,
 		},
 		"connections/:connectionId/scopes/*scopeId": {
 			"GET":    api.GetScope,
 			"PATCH":  api.UpdateScope,
 			"DELETE": api.DeleteScope,
 		},
 		"connections/:connectionId/scopes": {
 			"GET": api.GetScopeList,
 			"PUT": api.PutScope,
 		},
 		"connections/:connectionId/scope-configs": {
 			"POST": api.CreateScopeConfig,
 			"GET":  api.GetScopeConfigList,
 		},
 		"connections/:connectionId/scope-configs/:id": {
 			"PATCH":  api.UpdateScopeConfig,
 			"GET":    api.GetScopeConfig,
 			"DELETE": api.DeleteScopeConfig,
 		},
 		"connections/:connectionId/proxy/rest/*path": {
 			"GET": api.Proxy,
 		},
 	}
 }

 func (p Jenkins) Close(taskCtx plugin.TaskContext) errors.Error {
 	data, ok := taskCtx.GetData().(*tasks.JenkinsTaskData)
 	if !ok {
 		return errors.Default.New(fmt.Sprintf("GetData failed when try to close %+v", taskCtx))
 	}
 	data.ApiClient.Release()
 	return nil
 }

 func EnrichOptions(taskCtx plugin.TaskContext,
 	op *tasks.JenkinsOptions,
 	apiClient *helper.ApiAsyncClient) errors.Error {
 	jenkinsJob := &models.JenkinsJob{}
 	// If this is from BpV200, we should set JobFullName to scopeId
 	if op.JobFullName == "" {
 		op.JobFullName = op.ScopeId
 	}
 	// validate the op and set name=owner/repo if this is from advanced mode or bpV100
 	op, err := tasks.ValidateTaskOptions(op)
 	if err != nil {
 		return err
 	}
 	log := taskCtx.GetLogger()

 	// for advanced mode or others which we only have name, for bp v200, we have ScopeConfigId
 	err = taskCtx.GetDal().First(jenkinsJob,
 		dal.Where(`connection_id = ? and full_name = ?`,
 			op.ConnectionId, op.JobFullName))
 	if err == nil {
 		if op.ScopeConfigId == 0 {
 			op.ScopeConfigId = jenkinsJob.ScopeConfigId
 		}
 	}

 	err = api.GetJob(apiClient, op.JobPath, op.JobName, op.JobFullName, 100, func(job *models.Job, isPath bool) errors.Error {
 		log.Debug(fmt.Sprintf("Current job: %s", job.FullName))
 		op.JobPath = job.Path
 		jenkinsJob := job.ConvertApiScope().(*models.JenkinsJob)

 		jenkinsJob.ConnectionId = op.ConnectionId
 		jenkinsJob.ScopeConfigId = op.ScopeConfigId

 		err = taskCtx.GetDal().CreateIfNotExist(jenkinsJob)
 		return err
 	})
 	if err != nil {
 		return err
 	}

 	if !strings.HasSuffix(op.JobPath, "/") {
 		op.JobPath = fmt.Sprintf("%s/", op.JobPath)
 	}
 	// We only set op.JenkinsScopeConfig when it's nil and we have op.ScopeConfigId != 0
 	if op.ScopeConfig.DeploymentPattern == "" && op.ScopeConfig.ProductionPattern == "" && op.ScopeConfigId != 0 {
 		var scopeConfig models.JenkinsScopeConfig
 		err = taskCtx.GetDal().First(&scopeConfig, dal.Where("id = ?", op.ScopeConfigId))
 		if err != nil {
 			return errors.BadInput.Wrap(err, "fail to get scopeConfig")
 		}
 		op.ScopeConfig = &scopeConfig
 	}

 	if op.ScopeConfig.DeploymentPattern == "" && op.ScopeConfig.ProductionPattern == "" && op.ScopeConfigId == 0 {
 		op.ScopeConfig = new(models.JenkinsScopeConfig)
 	}

 	return nil
 }
	/*
	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 impl

	import (
	"fmt"
	"strings"
	"time"

	"github.com/apache/incubator-devlake/core/context"
	"github.com/apache/incubator-devlake/core/dal"
	"github.com/apache/incubator-devlake/core/models/domainlayer/devops"

	"github.com/apache/incubator-devlake/core/errors"
	"github.com/apache/incubator-devlake/core/plugin"
	helper "github.com/apache/incubator-devlake/helpers/pluginhelper/api"
	"github.com/apache/incubator-devlake/plugins/jenkins/api"
	"github.com/apache/incubator-devlake/plugins/jenkins/models"
	"github.com/apache/incubator-devlake/plugins/jenkins/models/migrationscripts"
	"github.com/apache/incubator-devlake/plugins/jenkins/tasks"
	)

	var _ interface {
	plugin.PluginMeta
	plugin.PluginInit
	plugin.PluginTask
	plugin.PluginApi
	plugin.PluginModel
	plugin.PluginMigration
	plugin.CloseablePluginTask
	plugin.PluginSource
	plugin.DataSourcePluginBlueprintV200
	} = (*Jenkins)(nil)

	type Jenkins struct{}

	func (p Jenkins) Init(basicRes context.BasicRes) errors.Error {
	api.Init(basicRes, p)

	return nil
	}

	func (p Jenkins) Connection() dal.Tabler {
	return &models.JenkinsConnection{}
	}

	func (p Jenkins) Scope() plugin.ToolLayerScope {
	return &models.JenkinsJob{}
	}

	func (p Jenkins) ScopeConfig() dal.Tabler {
	return &models.JenkinsScopeConfig{}
	}

	func (p Jenkins) GetTablesInfo() []dal.Tabler {
	return []dal.Tabler{
	&models.JenkinsBuild{},
	&models.JenkinsBuildCommit{},
	&models.JenkinsConnection{},
	&models.JenkinsJob{},
	&models.JenkinsJobDag{},
	&models.JenkinsStage{},
	&models.JenkinsScopeConfig{},
	}
	}

	func (p Jenkins) Description() string {
	return "To collect and enrich data from Jenkins"
	}

	func (p Jenkins) Name() string {
	return "jenkins"
	}

	func (p Jenkins) SubTaskMetas() []plugin.SubTaskMeta {
	return []plugin.SubTaskMeta{
	tasks.ConvertJobsMeta,
	tasks.CollectApiBuildsMeta,
	tasks.ExtractApiBuildsMeta,
	tasks.CollectApiStagesMeta,
	tasks.ExtractApiStagesMeta,
	tasks.EnrichApiBuildWithStagesMeta,
	tasks.ConvertBuildsToCicdTasksMeta,
	tasks.ConvertStagesMeta,
	tasks.ConvertBuildReposMeta,
	}
	}
	func (p Jenkins) PrepareTaskData(taskCtx plugin.TaskContext, options map[string]interface{}) (interface{}, errors.Error) {
	// Firstly, let's decode options to JenkinsOptions
	op, err := tasks.DecodeTaskOptions(options)
	if err != nil {
	return nil, err
	}

	logger := taskCtx.GetLogger()
	logger.Debug("%v", options)
	connection := &models.JenkinsConnection{}
	connectionHelper := helper.NewConnectionHelper(
	taskCtx,
	nil,
	p.Name(),
	)
	if err != nil {
	return nil, err
	}
	err = connectionHelper.FirstById(connection, op.ConnectionId)
	if err != nil {
	return nil, err
	}

	apiClient, err := tasks.CreateApiClient(taskCtx, connection)
	if err != nil {
	return nil, err
	}

	err = EnrichOptions(taskCtx, op, apiClient)
	if err != nil {
	return nil, err
	}

	var timeAfter time.Time
	if op.TimeAfter != "" {
	timeAfter, err = errors.Convert01(time.Parse(time.RFC3339, op.TimeAfter))
	if err != nil {
	return nil, errors.BadInput.Wrap(err, "invalid value for `timeAfter`")
	}
	}
	regexEnricher := helper.NewRegexEnricher()
	if err := regexEnricher.TryAdd(devops.DEPLOYMENT, op.ScopeConfig.DeploymentPattern); err != nil {
	return nil, errors.BadInput.Wrap(err, "invalid value for `deploymentPattern`")
	}
	if err := regexEnricher.TryAdd(devops.PRODUCTION, op.ScopeConfig.ProductionPattern); err != nil {
	return nil, errors.BadInput.Wrap(err, "invalid value for `productionPattern`")
	}
	taskData := &tasks.JenkinsTaskData{
	Options: op,
	ApiClient: apiClient,
	Connection: connection,
	RegexEnricher: regexEnricher,
	}
	if !timeAfter.IsZero() {
	taskData.TimeAfter = &timeAfter
	logger.Debug("collect data created from %s", timeAfter)
	}
	return taskData, nil
	}

	func (p Jenkins) RootPkgPath() string {
	return "github.com/apache/incubator-devlake/plugins/jenkins"
	}

	func (p Jenkins) MigrationScripts() []plugin.MigrationScript {
	return migrationscripts.All()
	}

	func (p Jenkins) MakeDataSourcePipelinePlanV200(connectionId uint64, scopes []*plugin.BlueprintScopeV200, syncPolicy plugin.BlueprintSyncPolicy) (pp plugin.PipelinePlan, sc []plugin.Scope, err errors.Error) {
	return api.MakeDataSourcePipelinePlanV200(p.SubTaskMetas(), connectionId, scopes, &syncPolicy)
	}

	func (p Jenkins) ApiResources() map[string]map[string]plugin.ApiResourceHandler {
	return map[string]map[string]plugin.ApiResourceHandler{
	"test": {
	"POST": api.TestConnection,
	},
	"connections": {
	"POST": api.PostConnections,
	"GET": api.ListConnections,
	},
	"connections/:connectionId": {
	"PATCH": api.PatchConnection,
	"DELETE": api.DeleteConnection,
	"GET": api.GetConnection,
	},
	"connections/:connectionId/remote-scopes": {
	"GET": api.RemoteScopes,
	},
	"connections/:connectionId/search-remote-scopes": {
	"GET": api.SearchRemoteScopes,
	},
	"connections/:connectionId/scopes/*scopeId": {
	"GET": api.GetScope,
	"PATCH": api.UpdateScope,
	"DELETE": api.DeleteScope,
	},
	"connections/:connectionId/scopes": {
	"GET": api.GetScopeList,
	"PUT": api.PutScope,
	},
	"connections/:connectionId/scope-configs": {
	"POST": api.CreateScopeConfig,
	"GET": api.GetScopeConfigList,
	},
	"connections/:connectionId/scope-configs/:id": {
	"PATCH": api.UpdateScopeConfig,
	"GET": api.GetScopeConfig,
	"DELETE": api.DeleteScopeConfig,
	},
	"connections/:connectionId/proxy/rest/*path": {
	"GET": api.Proxy,
	},
	}
	}

	func (p Jenkins) Close(taskCtx plugin.TaskContext) errors.Error {
	data, ok := taskCtx.GetData().(*tasks.JenkinsTaskData)
	if !ok {
	return errors.Default.New(fmt.Sprintf("GetData failed when try to close %+v", taskCtx))
	}
	data.ApiClient.Release()
	return nil
	}

	func EnrichOptions(taskCtx plugin.TaskContext,
	op *tasks.JenkinsOptions,
	apiClient *helper.ApiAsyncClient) errors.Error {
	jenkinsJob := &models.JenkinsJob{}
	// If this is from BpV200, we should set JobFullName to scopeId
	if op.JobFullName == "" {
	op.JobFullName = op.ScopeId
	}
	// validate the op and set name=owner/repo if this is from advanced mode or bpV100
	op, err := tasks.ValidateTaskOptions(op)
	if err != nil {
	return err
	}
	log := taskCtx.GetLogger()

	// for advanced mode or others which we only have name, for bp v200, we have ScopeConfigId
	err = taskCtx.GetDal().First(jenkinsJob,
	dal.Where(`connection_id = ? and full_name = ?`,
	op.ConnectionId, op.JobFullName))
	if err == nil {
	if op.ScopeConfigId == 0 {
	op.ScopeConfigId = jenkinsJob.ScopeConfigId
	}
	}

	err = api.GetJob(apiClient, op.JobPath, op.JobName, op.JobFullName, 100, func(job *models.Job, isPath bool) errors.Error {
	log.Debug(fmt.Sprintf("Current job: %s", job.FullName))
	op.JobPath = job.Path
	jenkinsJob := job.ConvertApiScope().(*models.JenkinsJob)

	jenkinsJob.ConnectionId = op.ConnectionId
	jenkinsJob.ScopeConfigId = op.ScopeConfigId

	err = taskCtx.GetDal().CreateIfNotExist(jenkinsJob)
	return err
	})
	if err != nil {
	return err
	}

	if !strings.HasSuffix(op.JobPath, "/") {
	op.JobPath = fmt.Sprintf("%s/", op.JobPath)
	}
	// We only set op.JenkinsScopeConfig when it's nil and we have op.ScopeConfigId != 0
	if op.ScopeConfig.DeploymentPattern == "" && op.ScopeConfig.ProductionPattern == "" && op.ScopeConfigId != 0 {
	var scopeConfig models.JenkinsScopeConfig
	err = taskCtx.GetDal().First(&scopeConfig, dal.Where("id = ?", op.ScopeConfigId))
	if err != nil {
	return errors.BadInput.Wrap(err, "fail to get scopeConfig")
	}
	op.ScopeConfig = &scopeConfig
	}

	if op.ScopeConfig.DeploymentPattern == "" && op.ScopeConfig.ProductionPattern == "" && op.ScopeConfigId == 0 {
	op.ScopeConfig = new(models.JenkinsScopeConfig)
	}

	return nil
	}