Files
Charlie Egan 6601188c64 runtime: Correct naming & docs for version checking (#8191)
* runtime: Correct naming of version checking code

Rename telemetry functionality to version checking to accurately reflect
current behavior following
https://github.com/open-policy-agent/opa/pull/7756.

The system only checks GitHub releases for version updates without sending
any data about the OPA instance and so the privacy docs have been updated too.

Signed-off-by: Charlie Egan <charlie_egan@apple.com>

* Make WithTelemetryGatherers a no-op

Deprecate WithTelemetryGatherers since telemetry gathering has been removed.
The function now returns a no-op to maintain API compatibility without
breaking existing code that might uses it.

Signed-off-by: Charlie Egan <charlie_egan@apple.com>

---------

Signed-off-by: Charlie Egan <charlie_egan@apple.com>
2026-01-08 10:25:38 +00:00

90 lines
2.4 KiB
Go

// Copyright 2016 The OPA Authors. All rights reserved.
// Use of this source code is governed by an Apache2
// license that can be found in the LICENSE file.
package cmd
import (
"context"
"fmt"
"io"
"os"
"time"
"github.com/open-policy-agent/opa/v1/ast"
version2 "github.com/open-policy-agent/opa/v1/version"
"github.com/spf13/cobra"
"github.com/open-policy-agent/opa/cmd/internal/env"
"github.com/open-policy-agent/opa/internal/versioncheck"
)
func initVersion(root *cobra.Command, brand string) {
var check bool
var versionCommand = &cobra.Command{
Use: "version",
Short: `Print the version of ` + brand,
Long: `Show version and build information for ` + brand + `.`,
PreRunE: func(cmd *cobra.Command, args []string) error {
return env.CmdFlags.CheckEnvironmentVariables(cmd)
},
RunE: func(cmd *cobra.Command, args []string) error {
cmd.SilenceErrors = true
cmd.SilenceUsage = true
return generateCmdOutput(os.Stdout, check)
},
}
// The version command can also be used to check for the latest released OPA version.
// Some tools could use this for feature flagging purposes and hence this option is OFF by-default.
versionCommand.Flags().BoolVarP(&check, "check", "c", false, "check for latest "+brand+" release")
root.AddCommand(versionCommand)
}
func generateCmdOutput(out io.Writer, check bool) error {
fmt.Fprintln(out, "Version: "+version2.Version)
fmt.Fprintln(out, "Build Commit: "+version2.Vcs)
fmt.Fprintln(out, "Build Timestamp: "+version2.Timestamp)
fmt.Fprintln(out, "Build Hostname: "+version2.Hostname)
fmt.Fprintln(out, "Go Version: "+version2.GoVersion)
fmt.Fprintln(out, "Platform: "+version2.Platform)
fmt.Fprintln(out, "Rego Version: "+ast.DefaultRegoVersion.String())
var wasmAvailable string
if version2.WasmRuntimeAvailable() {
wasmAvailable = "available"
} else {
wasmAvailable = "unavailable"
}
fmt.Fprintln(out, "WebAssembly: "+wasmAvailable)
if check {
ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
err := checkOPAUpdate(ctx, out)
if err != nil {
fmt.Fprintf(out, "Error: %v\n", err)
return err
}
}
return nil
}
func checkOPAUpdate(ctx context.Context, out io.Writer) error {
checker, err := versioncheck.New(versioncheck.Options{})
if err != nil {
return err
}
resp, err := checker.LatestVersion(ctx)
if err != nil {
return err
}
fmt.Fprintln(out, resp.Pretty())
return nil
}