yq/pkg/yqlib/operator_shuffle.go

package yqlib

import (
	"container/list"
	"fmt"
	"math/rand"
)

func shuffleOperator(_ *dataTreeNavigator, context Context, _ *ExpressionNode) (Context, error) {

	// ignore CWE-338 gosec issue of not using crypto/rand
	// this is just to shuffle an array rather generating a
	// secret or something that needs proper rand.
	myRand := rand.New(rand.NewSource(Now().UnixNano())) // #nosec

	results := list.New()

	for el := context.MatchingNodes.Front(); el != nil; el = el.Next() {
		candidate := el.Value.(*CandidateNode)

		if candidate.Kind != SequenceNode {
			return context, fmt.Errorf("node at path [%v] is not an array (it's a %v)", candidate.GetNicePath(), candidate.Tag)
		}

		result := candidate.Copy()

		a := result.Content

		myRand.Shuffle(len(a), func(i, j int) {
			a[i], a[j] = a[j], a[i]
			oldIndex := a[i].Key.Value
			a[i].Key.Value = a[j].Key.Value
			a[j].Key.Value = oldIndex
		})

		results.PushBack(result)
	}
	return context.ChildContext(results), nil
}