Add Databricks Terraform Provider #6088

dim-ops · 2023-01-16T13:34:33Z

dim-ops
Jan 16, 2023

Hello 👋

I started a PR to integrate the provider terraform's databricks #6086.

I have followed the documentation but if you could confirm that I am going in the right direction? :)

Is there a specific process when integrating a new provider?

If you could confirm me your interest for this integration ? :)

Thank you :)

Answered by cxMiguelSilva

Jan 17, 2023

Hi @dim-ops, hope you are doing great!
Thank you so much for the contributions you have been doing! Amazing job!

It is always great to add new features and extend the coverage of KICS for new cloud providers and platforms, so we appreciate the addition you are doing.

Regarding integrating a new provider, I believe you are going in the right direction.
Below are the files that you have to update

Add a new cloud provider

Update `internal/constants/constants.go`

Add a new entry to the map present on line 80

AvailableCloudProviders = map[string]string{
		"alicloud": "",
		"aws":      "",
		"azure":    "",
		"gcp":      "",
        "newcp":    "",
	}

Update `pkg/engine/source/filesystem.go`

Updat…

View full answer

cxMiguelSilva · 2023-01-17T09:27:17Z

cxMiguelSilva
Jan 17, 2023
Maintainer

Hi @dim-ops, hope you are doing great!
Thank you so much for the contributions you have been doing! Amazing job!

It is always great to add new features and extend the coverage of KICS for new cloud providers and platforms, so we appreciate the addition you are doing.

Regarding integrating a new provider, I believe you are going in the right direction.
Below are the files that you have to update

Add a new cloud provider

Update `internal/constants/constants.go`

Add a new entry to the map present on line 80

AvailableCloudProviders = map[string]string{
		"alicloud": "",
		"aws":      "",
		"azure":    "",
		"gcp":      "",
        "newcp":    "",
	}

Update `pkg/engine/source/filesystem.go`

Update the values on the returned array present on line 83 in order to add the new cloud provider.

// ListSupportedCloudProviders returns a list of supported cloud providers
func ListSupportedCloudProviders() []string {
	return []string{"alicloud", "aws", "azure", "gcp"}
}

Update `pkg/engine/source/filesystem_test.go`

Update the want named array present on line 725 in order to match the added cloud provider present on filesystem.go file

func TestSource_ListSupportedCloudProviders(t *testing.T) {
	want := []string{"alicloud", "aws", "azure", "gcp", "newcp"}
	t.Run("test List Suported CP", func(t *testing.T) {
		got := ListSupportedCloudProviders()
		require.Equal(t, want, got)
	})
}

Add new entry to the queries path map on `test/main_test.go`

var (
	queriesPaths = map[string]model.QueryConfig{
		"../assets/queries/terraform/aws_bom":               {FileKind: []model.FileKind{model.KindTerraform, model.KindJSON}, Platform: "terraform"},
		"../assets/queries/terraform/aws":                   {FileKind: []model.FileKind{model.KindTerraform, model.KindJSON}, Platform: "terraform"},
		"../assets/queries/terraform/azure":                 {FileKind: []model.FileKind{model.KindTerraform, model.KindJSON}, Platform: "terraform"},
		"../assets/queries/terraform/gcp":                   {FileKind: []model.FileKind{model.KindTerraform, model.KindJSON}, Platform: "terraform"},
		"../assets/queries/terraform/gcp_bom":               {FileKind: []model.FileKind{model.KindTerraform, model.KindJSON}, Platform: "terraform"},
		"../assets/queries/terraform/github":                {FileKind: []model.FileKind{model.KindTerraform, model.KindJSON}, Platform: "terraform"},
		"../assets/queries/terraform/kubernetes":            {FileKind: []model.FileKind{model.KindTerraform, model.KindJSON}, Platform: "terraform"},
		"../assets/queries/terraform/general":               {FileKind: []model.FileKind{model.KindTerraform, model.KindJSON}, Platform: "terraform"},
		"../assets/queries/terraform/alicloud":              {FileKind: []model.FileKind{model.KindTerraform, model.KindJSON}, Platform: "terraform"},
		"../assets/queries/terraform/newcp":              	 {FileKind: []model.FileKind{model.KindTerraform, model.KindJSON}, Platform: "terraform"},
		"../assets/queries/crossplane/aws":                  {FileKind: []model.FileKind{model.KindYAML}, Platform: "crossplane"},
		"../assets/queries/crossplane/azure":                {FileKind: []model.FileKind{model.KindYAML}, Platform: "crossplane"},
		"../assets/queries/crossplane/gcp":                  {FileKind: []model.FileKind{model.KindYAML}, Platform: "crossplane"},
		"../assets/queries/pulumi/aws":                      {FileKind: []model.FileKind{model.KindYAML}, Platform: "pulumi"},
		"../assets/queries/pulumi/gcp":                      {FileKind: []model.FileKind{model.KindYAML}, Platform: "pulumi"},
		"../assets/queries/pulumi/kubernetes":               {FileKind: []model.FileKind{model.KindYAML}, Platform: "pulumi"},
		"../assets/queries/pulumi/azure":                    {FileKind: []model.FileKind{model.KindYAML}, Platform: "pulumi"},
		"../assets/queries/k8s":                             {FileKind: []model.FileKind{model.KindYAML, model.KindJSON}, Platform: "k8s"},
		"../assets/queries/cloudFormation/aws":              {FileKind: []model.FileKind{model.KindYAML, model.KindJSON}, Platform: "cloudFormation"},
		"../assets/queries/cloudFormation/aws_bom":          {FileKind: []model.FileKind{model.KindYAML, model.KindJSON}, Platform: "cloudFormation"},
		"../assets/queries/cloudFormation/aws_sam":          {FileKind: []model.FileKind{model.KindYAML}, Platform: "cloudFormation"},
		"../assets/queries/ansible/aws":                     {FileKind: []model.FileKind{model.KindYAML}, Platform: "ansible"},
		"../assets/queries/ansible/gcp":                     {FileKind: []model.FileKind{model.KindYAML}, Platform: "ansible"},
		"../assets/queries/ansible/azure":                   {FileKind: []model.FileKind{model.KindYAML}, Platform: "ansible"},
		"../assets/queries/dockerfile":                      {FileKind: []model.FileKind{model.KindDOCKER}, Platform: "dockerfile"},
		"../assets/queries/dockerCompose":                   {FileKind: []model.FileKind{model.KindYAML}, Platform: "dockerCompose"},
		"../assets/queries/openAPI/general":                 {FileKind: []model.FileKind{model.KindYAML, model.KindJSON}, Platform: "openAPI"},
		"../assets/queries/openAPI/3.0":                     {FileKind: []model.FileKind{model.KindYAML, model.KindJSON}, Platform: "openAPI"},
		"../assets/queries/openAPI/2.0":                     {FileKind: []model.FileKind{model.KindYAML, model.KindJSON}, Platform: "openAPI"},
		"../assets/queries/azureResourceManager":            {FileKind: []model.FileKind{model.KindJSON}, Platform: "azureResourceManager"},
		"../assets/queries/googleDeploymentManager/gcp":     {FileKind: []model.FileKind{model.KindYAML}, Platform: "googleDeploymentManager"},
		"../assets/queries/googleDeploymentManager/gcp_bom": {FileKind: []model.FileKind{model.KindYAML}, Platform: "googleDeploymentManager"},
		"../assets/queries/grpc":                            {FileKind: []model.FileKind{model.KindPROTO}, Platform: "grpc"},
		"../assets/queries/buildah":                         {FileKind: []model.FileKind{model.KindBUILDAH}, Platform: "buildah"},
		"../assets/queries/serverlessFW":                    {FileKind: []model.FileKind{model.KindYAML, model.KindYML}, Platform: "serverlessFW"},
		"../assets/queries/knative":                         {FileKind: []model.FileKind{model.KindYAML}, Platform: "knative"},
	}

Update git hub validation script on `.github/scripts/queries-validator/metadata-schema.json`

Add a new entry for the new cloud provider in the enum on line 84

Update documentation

Documentation files to update:

docs/commands.md
docs/dockerhub.md

1 reply

dim-ops Jan 17, 2023
Author

Thank you for your reply @cxMiguelSilva 🎉

I'm going to do it soon !

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Databricks Terraform Provider #6088

{{title}}

{{editor}}'s edit

{{editor}}'s edit

Replies: 1 comment 1 reply

{{title}}

{{title}}

{{editor}}'s edit

{{editor}}'s edit

Select a reply

Add Databricks Terraform Provider #6088

dim-ops Jan 16, 2023

Add a new cloud provider

Update internal/constants/constants.go

Update pkg/engine/source/filesystem.go

Replies: 1 comment · 1 reply

cxMiguelSilva Jan 17, 2023 Maintainer

Add a new cloud provider

Update internal/constants/constants.go

Update pkg/engine/source/filesystem.go

Update pkg/engine/source/filesystem_test.go

Add new entry to the queries path map on test/main_test.go

Update git hub validation script on .github/scripts/queries-validator/metadata-schema.json

Update documentation

dim-ops Jan 17, 2023 Author

dim-ops
Jan 16, 2023

Update `internal/constants/constants.go`

Update `pkg/engine/source/filesystem.go`

Replies: 1 comment 1 reply

cxMiguelSilva
Jan 17, 2023
Maintainer

Update `internal/constants/constants.go`

Update `pkg/engine/source/filesystem.go`

Update `pkg/engine/source/filesystem_test.go`

Add new entry to the queries path map on `test/main_test.go`

Update git hub validation script on `.github/scripts/queries-validator/metadata-schema.json`

dim-ops Jan 17, 2023
Author