Add licenses to .go files and GitHub action that validates it (#73)

Author: Didainius

.changes/v1.0.0/73-notes.md

@@ -17,7 +17,6 @@ jobs:
       GO111MODULE: on
 
     steps:
-
       - name: Check out code into the Go module directory
         uses: actions/checkout@v3
 
@@ -26,6 +25,9 @@ jobs:
         with:
           go-version-file: 'go.mod'
 
+      - name: licensecheck
+        run: make licensecheck
+
       - name: vet
         run: make vet
 

.github/workflows/check-code.yml

@@ -144,6 +144,9 @@ fmt:
 fmtcheck:
 	@sh -c "'$(CURDIR)/scripts/gofmtcheck.sh'"
 
+licensecheck:
+	@sh -c "'$(CURDIR)/scripts/licensecheck.sh'"
+
 # runs HCL validation
 hclcheck:
 	@sh -c "'$(CURDIR)/scripts/hcl-check.sh'"

GNUmakefile

@@ -1,3 +1,7 @@
+// © Broadcom. All Rights Reserved.
+// The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
+// SPDX-License-Identifier: MPL-2.0
+
 package main
 
 import (

main.go

@@ -0,0 +1,10 @@
+#!/usr/bin/env bash
+
+missing_license_files=$(find . -name "*.go" -type f -exec sh -c 'head -n 10 "$0" | grep -q "// © Broadcom. All Rights Reserved." || echo "License missing in: $0"' {} \;)
+
+if [ -z "$missing_license_files" ]; then
+  exit 0
+else 
+  echo ${missing_license_files}
+  exit 1
+fi

scripts/licensecheck.sh

@@ -1,5 +1,9 @@
 // IMPORTANT: DO NOT ADD build tags to this file
 
+// © Broadcom. All Rights Reserved.
+// The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
+// SPDX-License-Identifier: MPL-2.0
+
 package vcfa
 
 import (

vcfa/api_test.go

@@ -1,3 +1,7 @@
+// © Broadcom. All Rights Reserved.
+// The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
+// SPDX-License-Identifier: MPL-2.0
+
 package vcfa
 
 import (

vcfa/config.go

@@ -1,5 +1,9 @@
 //go:build api || functional || tm || cci || contentlibrary || org || ALL
 
+// © Broadcom. All Rights Reserved.
+// The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
+// SPDX-License-Identifier: MPL-2.0
+
 package vcfa
 
 // This module provides initialization routines for the whole suite

vcfa/config_test.go

@@ -1,5 +1,9 @@
 //go:build ALL || functional
 
+// © Broadcom. All Rights Reserved.
+// The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
+// SPDX-License-Identifier: MPL-2.0
+
 package vcfa
 
 import (

vcfa/datasource_not_found_test.go

@@ -1,3 +1,7 @@
+// © Broadcom. All Rights Reserved.
+// The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
+// SPDX-License-Identifier: MPL-2.0
+
 package vcfa
 
 import (

vcfa/datasource_vcfa_certificate.go

@@ -1,3 +1,7 @@
+// © Broadcom. All Rights Reserved.
+// The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
+// SPDX-License-Identifier: MPL-2.0
+
 package vcfa
 
 import (

vcfa/datasource_vcfa_content_library.go

@@ -1,3 +1,7 @@
+// © Broadcom. All Rights Reserved.
+// The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
+// SPDX-License-Identifier: MPL-2.0
+
 package vcfa
 
 import (

vcfa/datasource_vcfa_content_library_item.go

@@ -1,3 +1,7 @@
+// © Broadcom. All Rights Reserved.
+// The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
+// SPDX-License-Identifier: MPL-2.0
+
 package vcfa
 
 import (

vcfa/datasource_vcfa_edge_cluster.go

@@ -1,3 +1,7 @@
+// © Broadcom. All Rights Reserved.
+// The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
+// SPDX-License-Identifier: MPL-2.0
+
 package vcfa
 
 import (

vcfa/datasource_vcfa_edge_cluster_qos.go

@@ -1,3 +1,7 @@
+// © Broadcom. All Rights Reserved.
+// The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
+// SPDX-License-Identifier: MPL-2.0
+
 package vcfa
 
 import (

vcfa/datasource_vcfa_global_role.go

@@ -1,3 +1,7 @@
+// © Broadcom. All Rights Reserved.
+// The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
+// SPDX-License-Identifier: MPL-2.0
+
 package vcfa
 
 import (

vcfa/datasource_vcfa_ip_space.go

@@ -1,3 +1,7 @@
+// © Broadcom. All Rights Reserved.
+// The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
+// SPDX-License-Identifier: MPL-2.0
+
 package vcfa
 
 import (

vcfa/datasource_vcfa_kubeconfig.go

@@ -1,5 +1,9 @@
 //go:build cci || ALL || functional
 
+// © Broadcom. All Rights Reserved.
+// The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
+// SPDX-License-Identifier: MPL-2.0
+
 package vcfa
 
 import (

vcfa/datasource_vcfa_kubeconfig_test.go

@@ -1,3 +1,7 @@
+// © Broadcom. All Rights Reserved.
+// The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
+// SPDX-License-Identifier: MPL-2.0
+
 package vcfa
 
 import (

vcfa/datasource_vcfa_nsx_manager.go

@@ -1,3 +1,7 @@
+// © Broadcom. All Rights Reserved.
+// The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
+// SPDX-License-Identifier: MPL-2.0
+
 package vcfa
 
 import (

vcfa/datasource_vcfa_org.go

@@ -1,3 +1,7 @@
+// © Broadcom. All Rights Reserved.
+// The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
+// SPDX-License-Identifier: MPL-2.0
+
 package vcfa
 
 import (

vcfa/datasource_vcfa_org_ldap.go

@@ -1,3 +1,7 @@
+// © Broadcom. All Rights Reserved.
+// The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
+// SPDX-License-Identifier: MPL-2.0
+
 package vcfa
 
 import (

vcfa/datasource_vcfa_org_local_user.go

@@ -1,3 +1,7 @@
+// © Broadcom. All Rights Reserved.
+// The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
+// SPDX-License-Identifier: MPL-2.0
+
 package vcfa
 
 import (

vcfa/datasource_vcfa_org_networking.go

@@ -1,8 +1,13 @@
+// © Broadcom. All Rights Reserved.
+// The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
+// SPDX-License-Identifier: MPL-2.0
+
 package vcfa
 
 import (
 	"context"
 	"fmt"
+
 	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 )

vcfa/datasource_vcfa_org_oidc.go

@@ -1,8 +1,13 @@
+// © Broadcom. All Rights Reserved.
+// The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
+// SPDX-License-Identifier: MPL-2.0
+
 package vcfa
 
 import (
 	"context"
 	"fmt"
+
 	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 	"github.com/vmware/go-vcloud-director/v3/govcd"

vcfa/datasource_vcfa_org_region_quota.go

@@ -1,3 +1,7 @@
+// © Broadcom. All Rights Reserved.
+// The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
+// SPDX-License-Identifier: MPL-2.0
+
 package vcfa
 
 import (

vcfa/datasource_vcfa_org_regional_networking.go

@@ -1,3 +1,7 @@
+// © Broadcom. All Rights Reserved.
+// The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
+// SPDX-License-Identifier: MPL-2.0
+
 package vcfa
 
 import (

vcfa/datasource_vcfa_org_regional_networking_vpc_qos.go

@@ -1,3 +1,7 @@
+// © Broadcom. All Rights Reserved.
+// The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
+// SPDX-License-Identifier: MPL-2.0
+
 package vcfa
 
 import (

vcfa/datasource_vcfa_org_settings.go

@@ -1,3 +1,7 @@
+// © Broadcom. All Rights Reserved.
+// The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
+// SPDX-License-Identifier: MPL-2.0
+
 package vcfa
 
 import (

vcfa/datasource_vcfa_provider_gateway.go

@@ -1,7 +1,12 @@
+// © Broadcom. All Rights Reserved.
+// The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
+// SPDX-License-Identifier: MPL-2.0
+
 package vcfa
 
 import (
 	"context"
+
 	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 )

vcfa/datasource_vcfa_provider_ldap.go

@@ -1,3 +1,7 @@
+// © Broadcom. All Rights Reserved.
+// The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
+// SPDX-License-Identifier: MPL-2.0
+
 package vcfa
 
 import (

vcfa/datasource_vcfa_region.go

@@ -1,3 +1,7 @@
+// © Broadcom. All Rights Reserved.
+// The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
+// SPDX-License-Identifier: MPL-2.0
+
 package vcfa
 
 import (

vcfa/datasource_vcfa_region_storage_policy.go

@@ -1,3 +1,7 @@
+// © Broadcom. All Rights Reserved.
+// The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
+// SPDX-License-Identifier: MPL-2.0
+
 package vcfa
 
 import (

vcfa/datasource_vcfa_region_zone.go

@@ -1,3 +1,7 @@
+// © Broadcom. All Rights Reserved.
+// The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
+// SPDX-License-Identifier: MPL-2.0
+
 package vcfa
 
 import (

vcfa/datasource_vcfa_right.go

@@ -1,5 +1,9 @@
 //go:build tm || role || ALL || functional
 
+// © Broadcom. All Rights Reserved.
+// The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
+// SPDX-License-Identifier: MPL-2.0
+
 package vcfa
 
 import (

vcfa/datasource_vcfa_right_test.go

@@ -1,3 +1,7 @@
+// © Broadcom. All Rights Reserved.
+// The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
+// SPDX-License-Identifier: MPL-2.0
+
 package vcfa
 
 import (

vcfa/datasource_vcfa_rights_bundle.go

@@ -1,3 +1,7 @@
+// © Broadcom. All Rights Reserved.
+// The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
+// SPDX-License-Identifier: MPL-2.0
+
 package vcfa
 
 import (

vcfa/datasource_vcfa_role.go

@@ -1,3 +1,7 @@
+// © Broadcom. All Rights Reserved.
+// The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
+// SPDX-License-Identifier: MPL-2.0
+
 package vcfa
 
 import (

vcfa/datasource_vcfa_storage_class.go

@@ -1,3 +1,7 @@
+// © Broadcom. All Rights Reserved.
+// The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
+// SPDX-License-Identifier: MPL-2.0
+
 package vcfa
 
 import (

vcfa/datasource_vcfa_supervisor.go

@@ -1,3 +1,7 @@
+// © Broadcom. All Rights Reserved.
+// The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
+// SPDX-License-Identifier: MPL-2.0
+
 package vcfa
 
 import (

vcfa/datasource_vcfa_supervisor_namespace.go

@@ -1,3 +1,7 @@
+// © Broadcom. All Rights Reserved.
+// The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
+// SPDX-License-Identifier: MPL-2.0
+
 package vcfa
 
 import (

vcfa/datasource_vcfa_supervisor_zone.go

@@ -1,3 +1,7 @@
+// © Broadcom. All Rights Reserved.
+// The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
+// SPDX-License-Identifier: MPL-2.0
+
 package vcfa
 
 import (

vcfa/datasource_vcfa_tier0_gateway.go

@@ -1,3 +1,7 @@
+// © Broadcom. All Rights Reserved.
+// The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
+// SPDX-License-Identifier: MPL-2.0
+
 package vcfa
 
 import (

vcfa/datasource_vcfa_vcenter.go

@@ -1,3 +1,7 @@
+// © Broadcom. All Rights Reserved.
+// The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
+// SPDX-License-Identifier: MPL-2.0
+
 package vcfa
 
 import (

vcfa/datasource_vcfa_version.go

@@ -1,5 +1,9 @@
 //go:build ALL || tm || functional
 
+// © Broadcom. All Rights Reserved.
+// The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
+// SPDX-License-Identifier: MPL-2.0
+
 package vcfa
 
 import (