fix(framework): update code generator templates #2641
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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
Empty file.
This file contains hidden or 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,69 @@ | ||
| /* | ||
|
|
||
| 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 ( | ||
| "encoding/json" | ||
|
|
||
| "github.com/apache/incubator-devlake/plugins/core" | ||
| "github.com/apache/incubator-devlake/plugins/helper" | ||
| "github.com/apache/incubator-devlake/plugins/{{ .plugin_name }}/tasks" | ||
| ) | ||
|
|
||
| func MakePipelinePlan(subtaskMetas []core.SubTaskMeta, connectionId uint64, scope []*core.BlueprintScopeV100) (core.PipelinePlan, error) { | ||
| var err error | ||
| plan := make(core.PipelinePlan, len(scope)) | ||
| for i, scopeElem := range scope { | ||
| taskOptions := make(map[string]interface{}) | ||
| err = json.Unmarshal(scopeElem.Options, &taskOptions) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| taskOptions["connectionId"] = connectionId | ||
|
|
||
| //TODO Add transformation rules to task options | ||
|
|
||
| /* | ||
| var transformationRules tasks.TransformationRules | ||
| if len(scopeElem.Transformation) > 0 { | ||
| err = json.Unmarshal(scopeElem.Transformation, &transformationRules) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| } | ||
| */ | ||
| //taskOptions["transformationRules"] = transformationRules | ||
| _, err := tasks.DecodeAndValidateTaskOptions(taskOptions) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| // subtasks | ||
| subtasks, err := helper.MakePipelinePlanSubtasks(subtaskMetas, scopeElem.Entities) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| plan[i] = core.PipelineStage{ | ||
| { | ||
| Plugin: "{{ .plugin_name }}", | ||
| Subtasks: subtasks, | ||
| Options: taskOptions, | ||
| }, | ||
| } | ||
| } | ||
| return plan, nil | ||
| } | ||
This file contains hidden or 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,155 @@ | ||
| /* | ||
| 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 ( | ||
| "context" | ||
| "fmt" | ||
| "net/http" | ||
| "time" | ||
|
|
||
| "github.com/apache/incubator-devlake/plugins/core" | ||
| "github.com/apache/incubator-devlake/plugins/helper" | ||
| "github.com/apache/incubator-devlake/plugins/{{ .plugin_name }}/models" | ||
| "github.com/mitchellh/mapstructure" | ||
| ) | ||
|
|
||
| //TODO Please modify the following code to fit your needs | ||
| func TestConnection(input *core.ApiResourceInput) (*core.ApiResourceOutput, error) { | ||
| // decode | ||
| var err error | ||
| var connection models.TestConnectionRequest | ||
|
Contributor
There was a problem hiding this comment. Where is |
||
| err = mapstructure.Decode(input.Body, &connection) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| // validate | ||
| err = vld.Struct(connection) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| // test connection | ||
| apiClient, err := helper.NewApiClient( | ||
| context.TODO(), | ||
| connection.Endpoint, | ||
| map[string]string{ | ||
| "Authorization": fmt.Sprintf("Bearer %v", connection.Token), | ||
| }, | ||
| 3*time.Second, | ||
| connection.Proxy, | ||
| basicRes, | ||
| ) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| res, err := apiClient.Get("user", nil, nil) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| resBody := &models.ApiUserResponse{} | ||
| err = helper.UnmarshalResponse(res, resBody) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| if res.StatusCode != http.StatusOK { | ||
| return nil, fmt.Errorf("unexpected status code: %d", res.StatusCode) | ||
| } | ||
| return nil, nil | ||
| } | ||
|
|
||
| //TODO Please modify the folowing code to adapt to your plugin | ||
| /* | ||
| POST /plugins/{{ .PluginName }}/connections | ||
| { | ||
| "name": "{{ .PluginName }} data connection name", | ||
| "endpoint": "{{ .PluginName }} api endpoint, i.e. https://example.com", | ||
| "username": "username, usually should be email address", | ||
| "password": "{{ .PluginName }} api access token" | ||
| } | ||
| */ | ||
| func PostConnections(input *core.ApiResourceInput) (*core.ApiResourceOutput, error) { | ||
| // update from request and save to database | ||
| connection := &models.{{ .PluginName }}Connection{} | ||
| err := connectionHelper.Create(connection, input) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| return &core.ApiResourceOutput{Body: connection, Status: http.StatusOK}, nil | ||
| } | ||
|
|
||
| //TODO Please modify the folowing code to adapt to your plugin | ||
| /* | ||
| PATCH /plugins/{{ .PluginName }}/connections/:connectionId | ||
| { | ||
| "name": "{{ .PluginName }} data connection name", | ||
| "endpoint": "{{ .PluginName }} api endpoint, i.e. https://example.com", | ||
| "username": "username, usually should be email address", | ||
| "password": "{{ .PluginName }} api access token" | ||
| } | ||
| */ | ||
| func PatchConnection(input *core.ApiResourceInput) (*core.ApiResourceOutput, error) { | ||
| connection := &models.{{ .PluginName }}Connection{} | ||
| err := connectionHelper.Patch(connection, input) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| return &core.ApiResourceOutput{Body: connection}, nil | ||
| } | ||
|
|
||
| /* | ||
| DELETE /plugins/{{ .PluginName }}/connections/:connectionId | ||
| */ | ||
| func DeleteConnection(input *core.ApiResourceInput) (*core.ApiResourceOutput, error) { | ||
| connection := &models.{{ .PluginName }}Connection{} | ||
| err := connectionHelper.First(connection, input.Params) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| err = connectionHelper.Delete(connection) | ||
| return &core.ApiResourceOutput{Body: connection}, err | ||
| } | ||
|
|
||
| /* | ||
| GET /plugins/{{ .PluginName }}/connections | ||
| */ | ||
| func ListConnections(input *core.ApiResourceInput) (*core.ApiResourceOutput, error) { | ||
| var connections []models.{{ .PluginName }}Connection | ||
| err := connectionHelper.List(&connections) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| return &core.ApiResourceOutput{Body: connections, Status: http.StatusOK}, nil | ||
| } | ||
|
|
||
| //TODO Please modify the folowing code to adapt to your plugin | ||
| /* | ||
| GET /plugins/{{ .PluginName }}/connections/:connectionId | ||
| { | ||
| "name": "{{ .PluginName }} data connection name", | ||
| "endpoint": "{{ .PluginName }} api endpoint, i.e. https://merico.atlassian.net/rest", | ||
| "username": "username, usually should be email address", | ||
| "password": "{{ .PluginName }} api access token" | ||
| } | ||
| */ | ||
| func GetConnection(input *core.ApiResourceInput) (*core.ApiResourceOutput, error) { | ||
| connection := &models.{{ .PluginName }}Connection{} | ||
| err := connectionHelper.First(connection, input.Params) | ||
| return &core.ApiResourceOutput{Body: connection}, err | ||
| } | ||
This file contains hidden or 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,39 @@ | ||
| /* | ||
| 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 ( | ||
| "github.com/apache/incubator-devlake/plugins/core" | ||
| "github.com/apache/incubator-devlake/plugins/helper" | ||
| "github.com/go-playground/validator/v10" | ||
| "github.com/spf13/viper" | ||
| "gorm.io/gorm" | ||
| ) | ||
|
|
||
| var vld *validator.Validate | ||
| var connectionHelper *helper.ConnectionApiHelper | ||
| var basicRes core.BasicRes | ||
|
|
||
| func Init(config *viper.Viper, logger core.Logger, database *gorm.DB) { | ||
| basicRes = helper.NewDefaultBasicRes(config, logger, database) | ||
| vld = validator.New() | ||
| connectionHelper = helper.NewConnectionHelper( | ||
| basicRes, | ||
| vld, | ||
| ) | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
change
withApiClienttogenerateCompletePluginor other appropriate name?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
good idea