opentofu/tools/tools.go

// Copyright (c) The OpenTofu Authors
// SPDX-License-Identifier: MPL-2.0
// Copyright (c) 2023 HashiCorp, Inc.
// SPDX-License-Identifier: MPL-2.0

//go:build tools
// +build tools

package tools

import (
	_ "github.com/golang/mock/mockgen"
	_ "github.com/mitchellh/gox"
	_ "github.com/nishanths/exhaustive"
	_ "golang.org/x/tools/cmd/stringer"
	_ "google.golang.org/grpc/cmd/protoc-gen-go-grpc"
	_ "honnef.co/go/tools/cmd/staticcheck"
)
Update copyright notice (#1232) Signed-off-by: namgyalangmo <75657887+namgyalangmo@users.noreply.github.com> 2024-02-08 03:48:59 -06:00			`// Copyright (c) The OpenTofu Authors`
			`// SPDX-License-Identifier: MPL-2.0`
			`// Copyright (c) 2023 HashiCorp, Inc.`
[COMPLIANCE] Add Copyright and License Headers 2023-05-02 10:33:06 -05:00			`// SPDX-License-Identifier: MPL-2.0`

Upgrade to Go 1.17 This includes the addition of the new "//go:build" comment form in addition to the legacy "// +build" notation, as produced by gofmt to ensure consistent behavior between Go versions. The new directives are all equivalent to what was present before, so there's no change in behavior. Go 1.17 continues to use the Unicode 13 tables as in Go 1.16, so this upgrade does not require also upgrading our Unicode-related dependencies. This upgrade includes the following breaking changes which will also appear as breaking changes for Terraform users, but that are consistent with the Terraform v1.0 compatibility promises. - On MacOS, Terraform now requires macOS 10.13 High Sierra or later. This upgrade also includes the following breaking changes which will appear as breaking changes for Terraform users that are inconsistent with our compatibility promises, but have justified exceptions as follows: - cidrsubnet, cidrhost, and cidrnetmask will now reject IPv4 CIDR addresses whose decimal components have leading zeros, where previously they would just silently ignore those leading zeros. This is a security-motivated exception to our compatibility promises, because some external systems interpret zero-prefixed octets as octal numbers rather than decimal, and thus the previous lenient parsing could lead to a different interpretation of the address between systems, and thus potentially allow bypassing policy when configuring firewall rules etc. This upgrade also includes the following breaking changes which could _potentially_ appear as breaking changes for Terraform users, but that do not in practice for the reasons given: - The Go net/url package no longer allows query strings with pairs separated by semicolons instead of ampersands. This primarily affects HTTP servers written in Go, and Terraform includes a special temporary HTTP server as part of its implementation of OAuth for "terraform login", but that server only needs to accept URLs created by Terraform itself and Terraform does not generate any URLs that would be rejected. 2021-08-16 19:19:17 -05:00			`//go:build tools`
Version tools per Go convention under tools.go 2019-10-17 15:17:23 -05:00			`// +build tools`

			`package tools`

			`import (`
			`_ "github.com/golang/mock/mockgen"`
gofmt tools/tools.go 2020-06-17 10:04:43 -05:00			`_ "github.com/mitchellh/gox"`
build: Add exhaustive switch statement lint For now, only check the JSON views package, since this was the instance that most recently tripped us up. There are a few dozen failures elsewhere in Terraform which would need to be addressed before expanding this to other packages. 2021-09-24 14:02:30 -05:00			`_ "github.com/nishanths/exhaustive"`
Version tools per Go convention under tools.go 2019-10-17 15:17:23 -05:00			`_ "golang.org/x/tools/cmd/stringer"`
build: Centralize our protobuf compilation steps We have a few different .proto files in this repository that all need to get recompiled into .pb.go files each time we change them, but we were previously handling that with some scripts that just assumed that protoc and the relevant plugins were already installed on the system somewhere, at the right versions. In practice we've been constantly flopping between different versions of these tools due to folks having different versions installed in their development environments. In particular, the state of the .pb.go files in the prior commit wasn't reproducible by any single version of the tools because they've all slightly diverged from one another. In the interests of being more consistent here and avoiding accidental inconsistencies, we'll now centralize the protocol buffer compile steps all into a single tool that knows how to fetch and install the expected versions of the various tools we need and then run those tools with the right options to get a stable result. If we want to upgrade to either a newer protoc or a newer protoc-gen-go in future then we'll do that in a central location and update all of the .pb.go files at the same time, so that we're always consistently tracking the same version of protocol buffers everywhere. While doing this I attempted to keep as close as possible to the toolchain we'd most recently used, but since they were not consistent with each other they've now all changed which version numbers they record at minimum, and the planproto stub in particular now also has a slightly different descriptor serialization but is otherwise offering the same API. 2021-08-20 18:07:18 -05:00			`_ "google.golang.org/grpc/cmd/protoc-gen-go-grpc"`
add staticcheck to tools 2020-12-02 10:57:29 -06:00			`_ "honnef.co/go/tools/cmd/staticcheck"`
Version tools per Go convention under tools.go 2019-10-17 15:17:23 -05:00			`)`