🔨 overhaul featureflags: configuration + activation + metadata

This is a full overhaul of featureflags. They have now moved to features.yaml and can be configured with the new featureflags utility. This utility makes sure we never mix up IDs for features, sets up default and available features, and generates some helper go-code around featureflags.

The reason we are adding this now is:
- the use of default featureflags was inconsistent between different code paths
- the use of feature-loading from CLI and env variables was inconsistent as well
- a series of features that should have been set as default features by now have not been set - they were simply overlooked
- the list of features still contains a lot of names that have been builtin or sunset now i.e. setting them has no effect at all -> we can now identify what is usable and what is not

Signed-off-by: Dominik Richter <dominik.richter@gmail.com>

Author: arlimus

apps/cnquery/cmd/features.go

@@ -0,0 +1,27 @@
+// Copyright (c) Mondoo, Inc.
+// SPDX-License-Identifier: BUSL-1.1
+
+package cmd
+
+import (
+	"fmt"
+
+	"github.com/spf13/cobra"
+	"go.mondoo.com/cnquery/v12/cli/config"
+)
+
+// featuresCmd represents the version command
+var featuresCmd = &cobra.Command{
+	Hidden: true,
+	Use:    "features",
+	Short:  "Display cnquery features",
+	Run: func(cmd *cobra.Command, args []string) {
+		// prerequisite: features must be initialized via config on the root command
+		// otherwise config.Features won't contain anything useful
+		fmt.Println("Active features: " + config.Features.String())
+	},
+}
+
+func init() {
+	rootCmd.AddCommand(featuresCmd)
+}

cli/config/config.go

@@ -40,39 +40,17 @@ const (
 // Init initializes and loads the mondoo config
 func Init(rootCmd *cobra.Command) {
 	cobra.OnInitialize(InitViperConfig, func() {
-		Features = getFeatures()
+		var err error
+		Features, err = cnquery.InitFeatures(viper.GetStringSlice("features")...)
+		if err != nil {
+			log.Error().Msg(err.Error())
+		}
+		// by default we don't print the list of active features, at least not for now...
 	})
 	// persistent flags are global for the application
 	rootCmd.PersistentFlags().StringVar(&UserProvidedPath, "config", "", "Set config file path (default $HOME/.config/mondoo/mondoo.yml)")
 }
 
-func getFeatures() cnquery.Features {
-	bitSet := make([]bool, 256)
-	flags := []byte{}
-
-	for _, f := range cnquery.DefaultFeatures {
-		if !bitSet[f] {
-			bitSet[f] = true
-			flags = append(flags, f)
-		}
-	}
-
-	envFeatures := viper.GetStringSlice("features")
-	for _, name := range envFeatures {
-		flag, ok := cnquery.FeaturesValue[name]
-		if ok {
-			if !bitSet[byte(flag)] {
-				bitSet[byte(flag)] = true
-				flags = append(flags, byte(flag))
-			}
-		} else {
-			log.Warn().Str("feature", name).Msg("could not parse feature")
-		}
-	}
-
-	return cnquery.Features(flags)
-}
-
 func InitViperConfig() {
 	viper.SetConfigType("yaml")
 	// Effectively, we disable using a key delimiter in viper. So you cannot do something like

featureflags.go

@@ -18,119 +18,17 @@
 
 package cnquery
 
+//go:generate go run utils/featureflags/main.go features.yaml -type=Feature -out=features.go
 //go:generate go run golang.org/x/tools/cmd/stringer -type=Feature
 
 import (
 	"bytes"
 	"context"
 	"encoding/base64"
+	"errors"
+	"strings"
 )
 
-const (
-	// For all features, use this format:
-	// desc:   A description of this feature and what it does...
-	// start:  vX.x  (the version when it is introduced)
-	// end:    vZ.0  (the version when this flag will be removed)
-
-	// Feature flags:
-
-	// MassQueries feature flag
-	// desc:   Resolve similar queries the same way. If 100 assets have the same
-	//         dependent queries and overrides, they create the same resolved
-	//         plan. Cannot be used with old resolver at the same time for asset.
-	// start:  v3.x, available at v4.x, default at v5.x
-	// end:    v6.0 => default now, no need to set it anymore
-	MassQueries Feature = iota + 1
-
-	// PiperCode feature flag
-	// desc:   Allows MQL to use variable references across blocks. Fully changes
-	//         the compiled code.
-	// start:  v5.x
-	// end:    v7.0 => default now, no need to set it anymore
-	PiperCode
-
-	// BoolAssertions feature flag
-	// desc:  Only boolean results are checked when evaluating a query for success
-	//
-	// start: v6.x
-	// end:   v8.0
-	BoolAssertions
-
-	// K8sNodeDiscovery feature flag
-	// desc:  Enables discovery of Kubernetes cluster nodes as individual assets
-	//
-	// start: v6.12
-	// end:   unknown
-	K8sNodeDiscovery
-
-	// MQLAssetContext feature flag
-	//
-	// start: v7.0
-	// updated: v11.0  We default to embed flags and re-use this feature for actual asset context
-	// end:   v12.0
-	MQLAssetContext
-
-	// ErrorsAsFailures feature flag
-	// desc:  Errors are treated as failures
-	//        See https://www.notion.so/mondoo/Errors-and-Scoring-5dc554348aad4118a1dbf35123368329
-	// start: v8.x
-	// end:   v9.0
-	ErrorsAsFailures
-
-	// StoreResourcesData feature flag
-	// desc:  Stores recording-like data with upstream
-	// start: v10.x
-	// end:   tbd (candidate: v11.0)
-	StoreResourcesData
-
-	// FineGrainedAssets feature flag
-	// desc:  Enables fine-grained assets discovery
-	// start: v11.x
-	// end:   tbd (candidate: v12.0)
-	FineGrainedAssets
-
-	// SerialNumberAsID feature flag
-	// desc:  Use serial number as the asset ID
-	// start: v11.x
-	// end:   tbd (candidate: v12.0)
-	SerialNumberAsID
-
-	// ForceShellCompletion feature flag
-	// desc:  Forces shell completion to be enabled (for windows)
-	// start: v11.x
-	ForceShellCompletion
-
-	// ResourceContext feature flag
-	// desc:  Automatically add resource context to results and prints it
-	// start: v11.x
-	ResourceContext
-
-	// FailIfNoEntryPoints feature flag
-	// desc:  Fail if no entrypoints or datapoints are found in the query.
-	FailIfNoEntryPoints
-)
-
-// FeaturesValue is a map from feature name to feature flag
-var FeaturesValue = map[string]Feature{
-	MassQueries.String():          MassQueries,
-	PiperCode.String():            PiperCode,
-	BoolAssertions.String():       BoolAssertions,
-	MQLAssetContext.String():      MQLAssetContext,
-	ErrorsAsFailures.String():     ErrorsAsFailures,
-	StoreResourcesData.String():   StoreResourcesData,
-	FineGrainedAssets.String():    FineGrainedAssets,
-	SerialNumberAsID.String():     SerialNumberAsID,
-	ForceShellCompletion.String(): ForceShellCompletion,
-	ResourceContext.String():      ResourceContext,
-	FailIfNoEntryPoints.String():  FailIfNoEntryPoints,
-}
-
-// DefaultFeatures are a set of default flags that are active
-var DefaultFeatures = Features{
-	byte(MassQueries),
-	byte(PiperCode),
-}
-
 // Features is a collection of activated features
 type Features []byte
 
@@ -147,6 +45,15 @@ func (f Features) Encode() string {
 	return base64.StdEncoding.EncodeToString(f)
 }
 
+// String returns a list of features into human-readable form
+func (f Features) String() string {
+	all := make([]string, len(f))
+	for i, cur := range f {
+		all[i] = Feature(cur).String()
+	}
+	return strings.Join(all, ", ")
+}
+
 // DecodeFeatures that were previously encoded
 func DecodeFeatures(s string) (Features, error) {
 	data, err := base64.StdEncoding.DecodeString(s)
@@ -169,3 +76,52 @@ func GetFeatures(ctx context.Context) Features {
 	}
 	return f
 }
+
+// InitFeatures initialized everything using the default features
+// and can turn individual features on and off based on the
+// strings that are provided. To turn a feature on just use its
+// name. To turn it off use the "no" prefix in front of its name.
+// Feature names are case-sensitive
+func InitFeatures(features ...string) (Features, error) {
+	bitSet := make([]bool, MAX_FEATURES)
+
+	for _, f := range DefaultFeatures {
+		if !bitSet[f] {
+			bitSet[f] = true
+		}
+	}
+
+	var failing []string
+	for _, name := range features {
+		flag, ok := FeaturesValue[name]
+		if ok {
+			bitSet[byte(flag)] = true
+			continue
+		}
+
+		rest, found := strings.CutPrefix(name, "no")
+		if found {
+			flag, ok = FeaturesValue[rest]
+			if ok {
+				bitSet[byte(flag)] = false
+				continue
+			}
+		}
+
+		failing = append(failing, name)
+	}
+
+	flags := []byte{}
+	for i := 1; i < int(MAX_FEATURES); i++ {
+		if bitSet[i] {
+			flags = append(flags, byte(i))
+		}
+	}
+
+	var err error
+	if len(failing) != 0 {
+		err = errors.New("Failed to parse feature-flags: " + strings.Join(failing, ", "))
+	}
+
+	return Features(flags), err
+}