[#922] cli: Add new command control list-targets

Signed-off-by: Anton Nikiforov <an.nikiforov@yadro.com>

Makefile

@@ -259,4 +259,4 @@ env-down:
 	docker volume rm -f frostfs-node_neo-go
 	rm -f ./.cache/.frostfs-ir-state
 	rm -f ./.cache/.frostfs-node-state
-	rm -rf ./.cache/storage
+	rm -rf ./.cache/storage

README.md

@@ -104,7 +104,7 @@ Enter password >  <- press ENTER, the is no password for wallet
 CID: CfPhEuHQ2PRvM4gfBQDC4dWZY3NccovyfcnEdiq2ixju
 
 ./bin/frostfs-cli object put -r 127.0.0.1:8080 --wallet ./dev/wallet.json --file README.md --cid CfPhEuHQ2PRvM4gfBQDC4dWZY3NccovyfcnEdiq2ixju
-Enter password > 
+Enter password >
  4300 / 4300 [===========================================================================================================================================================================================================] 100.00% 0s
 [README.md] Object successfully stored
   OID: 78sohnudVMnPsczXqsTUcvezosan2YDNVZwDE8Kq5YwU

cmd/frostfs-cli/modules/control/list_targets.go

@@ -0,0 +1,82 @@
+package control
+
+import (
+	"bytes"
+	"crypto/sha256"
+	"fmt"
+	"strconv"
+	"text/tabwriter"
+
+	"git.frostfs.info/TrueCloudLab/frostfs-api-go/v2/rpc/client"
+	"git.frostfs.info/TrueCloudLab/frostfs-node/cmd/frostfs-cli/internal/key"
+	commonCmd "git.frostfs.info/TrueCloudLab/frostfs-node/cmd/internal/common"
+	"git.frostfs.info/TrueCloudLab/frostfs-node/pkg/services/control"
+	cid "git.frostfs.info/TrueCloudLab/frostfs-sdk-go/container/id"
+	"github.com/spf13/cobra"
+)
+
+const (
+	chainNameFlag      = "chain-name"
+	chainNameFlagUsage = "Chain name(ingress|s3)"
+)
+
+var listTargetsCmd = &cobra.Command{
+	Use:   "list-targets",
+	Short: "List local targets",
+	Long:  "List local APE overrides of the node",
+	Run:   listTargets,
+}
+
+func listTargets(cmd *cobra.Command, _ []string) {
+	pk := key.Get(cmd)
+
+	var cnr cid.ID
+	chainName, _ := cmd.Flags().GetString(chainNameFlag)
+
+	rawCID := make([]byte, sha256.Size)
+	cnr.Encode(rawCID)
+
+	req := &control.ListTargetsLocalOverridesRequest{
+		Body: &control.ListTargetsLocalOverridesRequest_Body{
+			ChainName: chainName,
+		},
+	}
+
+	signRequest(cmd, pk, req)
+
+	cli := getClient(cmd, pk)
+
+	var resp *control.ListTargetsLocalOverridesResponse
+	var err error
+	err = cli.ExecRaw(func(client *client.Client) error {
+		resp, err = control.ListTargetsLocalOverrides(client, req)
+		return err
+	})
+	commonCmd.ExitOnErr(cmd, "rpc error: %w", err)
+
+	verifyResponse(cmd, resp.GetSignature(), resp.GetBody())
+
+	targets := resp.GetBody().GetTargets()
+	if len(targets) == 0 {
+		cmd.Println("Local overrides are not defined for the container.")
+		return
+	}
+
+	buf := bytes.NewBuffer(nil)
+	tw := tabwriter.NewWriter(buf, 0, 2, 2, ' ', 0)
+	_, _ = tw.Write([]byte("#\tName\tType\n"))
+	for i, t := range targets {
+		_, _ = tw.Write([]byte(fmt.Sprintf("%s\t%s\t%s\n", strconv.Itoa(i), t.GetName(), t.GetType())))
+	}
+	_ = tw.Flush()
+	cmd.Print(buf.String())
+}
+
+func initControlListTargetsCmd() {
+	initControlFlags(listTargetsCmd)
+
+	ff := listTargetsCmd.Flags()
+	ff.String(chainNameFlag, "", chainNameFlagUsage)
+
+	_ = cobra.MarkFlagRequired(ff, chainNameFlag)
+}

cmd/frostfs-cli/modules/control/root.go

@@ -38,6 +38,7 @@ func init() {
 		removeRuleCmd,
 		listRulesCmd,
 		getRuleCmd,
+		listTargetsCmd,
 	)
 
 	initControlHealthCheckCmd()
@@ -50,4 +51,5 @@ func init() {
 	initControlRemoveRuleCmd()
 	initControlListRulesCmd()
 	initControGetRuleCmd()
+	initControlListTargetsCmd()
 }

dev/.vscode-example/launch.json

@@ -86,4 +86,4 @@
           "stopAll": true
         }
     ]
-}
+}

dev/.vscode-example/tasks.json

@@ -16,4 +16,4 @@
 			"detail": "Down debug environment"
 		}
 	]
-}
+}

dev/ir/az.json

@@ -66,4 +66,3 @@
     "Tokens": null
   }
 }
-

go.mod

@@ -8,7 +8,7 @@ require (
 	git.frostfs.info/TrueCloudLab/frostfs-observability v0.0.0-20231101111734-b3ad3335ff65
 	git.frostfs.info/TrueCloudLab/frostfs-sdk-go v0.0.0-20240126141009-65b4525b3bf0
 	git.frostfs.info/TrueCloudLab/hrw v1.2.1
-	git.frostfs.info/TrueCloudLab/policy-engine v0.0.0-20240122104724-06cbfe8691ad
+	git.frostfs.info/TrueCloudLab/policy-engine v0.0.0-20240129064140-8d21ab2d99d9
 	git.frostfs.info/TrueCloudLab/tzhash v1.8.0
 	github.com/cheggaaa/pb v1.0.29
 	github.com/chzyer/readline v1.5.1
@@ -76,8 +76,10 @@ require (
 	github.com/holiman/uint256 v1.2.4 // indirect
 	github.com/inconshreveable/mousetrap v1.1.0 // indirect
 	github.com/ipfs/go-cid v0.4.1 // indirect
+	github.com/josharian/intern v1.0.0 // indirect
 	github.com/klauspost/cpuid/v2 v2.2.6 // indirect
 	github.com/magiconair/properties v1.8.7 // indirect
+	github.com/mailru/easyjson v0.7.7 // indirect
 	github.com/mattn/go-runewidth v0.0.15 // indirect
 	github.com/minio/sha256-simd v1.0.1 // indirect
 	github.com/mitchellh/mapstructure v1.5.0 // indirect

pkg/ape/chainbase/boltdb.go

@@ -167,8 +167,8 @@ func getTargetBucketCreateIfEmpty(tx *bbolt.Tx, name chain.Name, target policyen
 }
 
 func (cs *boltLocalOverrideStorage) AddOverride(name chain.Name, target policyengine.Target, c *chain.Chain) (chain.ID, error) {
-	if c.ID == "" {
-		return "", fmt.Errorf("chain ID is not set")
+	if len(c.ID) == 0 {
+		return chain.ID{}, fmt.Errorf("chain ID is not set")
 	}
 
 	serializedChain := c.Bytes()
@@ -264,3 +264,48 @@ func (cs *boltLocalOverrideStorage) DropAllOverrides(name chain.Name) error {
 		return tx.DeleteBucket([]byte(name))
 	})
 }
+
+func (cs *boltLocalOverrideStorage) ListOverrideDefinedTargets(name chain.Name) ([]policyengine.Target, error) {
+	var targets []policyengine.Target
+	if err := cs.db.View(func(tx *bbolt.Tx) error {
+		var err error
+		targets, err = getTargets(tx, name)
+		if err != nil {
+			return err
+		}
+		return nil
+	}); err != nil {
+		return nil, err
+	}
+	return targets, nil
+}
+
+func getTargets(tx *bbolt.Tx, name chain.Name) ([]policyengine.Target, error) {
+	var targets []policyengine.Target
+	cbucket := tx.Bucket(chainBucket)
+	if cbucket == nil {
+		return nil, ErrRootBucketNotFound
+	}
+
+	nbucket := cbucket.Bucket([]byte(name))
+	if nbucket == nil {
+		return nil, fmt.Errorf("%w: %w: %s", policyengine.ErrChainNotFound, ErrGlobalNamespaceBucketNotFound, name)
+	}
+
+	if err := nbucket.ForEachBucket(func(k []byte) error {
+		ttype := policyengine.TargetType(k[0])
+		if err := nbucket.Bucket(k).ForEachBucket(func(k []byte) error {
+			targets = append(targets, policyengine.Target{
+				Type: ttype,
+				Name: string(slice.Copy(k)),
+			})
+			return nil
+		}); err != nil {
+			return err
+		}
+		return nil
+	}); err != nil {
+		return nil, err
+	}
+	return targets, nil
+}

pkg/services/control/rpc.go

@@ -8,23 +8,24 @@ import (
 const serviceName = "control.ControlService"
 
 const (
-	rpcHealthCheck              = "HealthCheck"
-	rpcSetNetmapStatus          = "SetNetmapStatus"
-	rpcDropObjects              = "DropObjects"
-	rpcListShards               = "ListShards"
-	rpcSetShardMode             = "SetShardMode"
-	rpcSynchronizeTree          = "SynchronizeTree"
-	rpcEvacuateShard            = "EvacuateShard"
-	rpcStartShardEvacuation     = "StartShardEvacuation"
-	rpcGetShardEvacuationStatus = "GetShardEvacuationStatus"
-	rpcStopShardEvacuation      = "StopShardEvacuation"
-	rpcFlushCache               = "FlushCache"
-	rpcDoctor                   = "Doctor"
-	rpcAddChainLocalOverride    = "AddChainLocalOverride"
-	rpcGetChainLocalOverride    = "GetChainLocalOverride"
-	rpcListChainLocalOverrides  = "ListChainLocalOverrides"
-	rpcRemoveChainLocalOverride = "RemoveChainLocalOverride"
-	rpcSealWriteCache           = "SealWriteCache"
+	rpcHealthCheck               = "HealthCheck"
+	rpcSetNetmapStatus           = "SetNetmapStatus"
+	rpcDropObjects               = "DropObjects"
+	rpcListShards                = "ListShards"
+	rpcSetShardMode              = "SetShardMode"
+	rpcSynchronizeTree           = "SynchronizeTree"
+	rpcEvacuateShard             = "EvacuateShard"
+	rpcStartShardEvacuation      = "StartShardEvacuation"
+	rpcGetShardEvacuationStatus  = "GetShardEvacuationStatus"
+	rpcStopShardEvacuation       = "StopShardEvacuation"
+	rpcFlushCache                = "FlushCache"
+	rpcDoctor                    = "Doctor"
+	rpcAddChainLocalOverride     = "AddChainLocalOverride"
+	rpcGetChainLocalOverride     = "GetChainLocalOverride"
+	rpcListChainLocalOverrides   = "ListChainLocalOverrides"
+	rpcRemoveChainLocalOverride  = "RemoveChainLocalOverride"
+	rpcSealWriteCache            = "SealWriteCache"
+	rpcListTargetsLocalOverrides = "ListTargetsLocalOverrides"
 )
 
 // HealthCheck executes ControlService.HealthCheck RPC.
@@ -240,6 +241,19 @@ func ListChainLocalOverrides(cli *client.Client, req *ListChainLocalOverridesReq
 	return wResp.message, nil
 }
 
+// ListTargetsLocalOverrides executes ControlService.ListTargetsLocalOverrides RPC.
+func ListTargetsLocalOverrides(cli *client.Client, req *ListTargetsLocalOverridesRequest, opts ...client.CallOption) (*ListTargetsLocalOverridesResponse, error) {
+	wResp := newResponseWrapper[ListTargetsLocalOverridesResponse]()
+	wReq := &requestWrapper{m: req}
+
+	err := client.SendUnary(cli, common.CallMethodInfoUnary(serviceName, rpcListTargetsLocalOverrides), wReq, wResp, opts...)
+	if err != nil {
+		return nil, err
+	}
+
+	return wResp.message, nil
+}
+
 // RemoveChainLocalOverride executes ControlService.RemoveChainLocalOverride RPC.
 func GetChainLocalOverride(cli *client.Client, req *GetChainLocalOverrideRequest, opts ...client.CallOption) (*GetChainLocalOverrideResponse, error) {
 	wResp := newResponseWrapper[GetChainLocalOverrideResponse]()

pkg/services/control/server/policy_engine.go

@@ -25,6 +25,29 @@ func apeTarget(chainTarget *control.ChainTarget) (engine.Target, error) {
 		fmt.Errorf("target type is not supported: %s", chainTarget.GetType().String()).Error())
 }
 
+func controlTarget(chainTarget *engine.Target) (control.ChainTarget, error) {
+	switch chainTarget.Type {
+	case engine.Container:
+		return control.ChainTarget{
+			Name: chainTarget.Name,
+			Type: control.ChainTarget_CONTAINER,
+		}, nil
+	case engine.Namespace:
+		// If namespace is empty, we take it for root namespace.
+		nm := chainTarget.Name
+		if nm == "root" {
+			nm = ""
+		}
+		return control.ChainTarget{
+			Name: nm,
+			Type: control.ChainTarget_NAMESPACE,
+		}, nil
+	default:
+	}
+	return control.ChainTarget{}, status.Error(codes.InvalidArgument,
+		fmt.Errorf("target type is not supported: %c", chainTarget.Type).Error())
+}
+
 func (s *Server) AddChainLocalOverride(_ context.Context, req *control.AddChainLocalOverrideRequest) (*control.AddChainLocalOverrideResponse, error) {
 	if err := s.isValidRequest(req); err != nil {
 		return nil, status.Error(codes.PermissionDenied, err.Error())
@@ -44,7 +67,7 @@ func (s *Server) AddChainLocalOverride(_ context.Context, req *control.AddChainL
 
 	s.apeChainCounter.Add(1)
 	// TODO (aarifullin): the such chain id is not well-designed yet.
-	if chain.ID == "" {
+	if len(chain.ID) == 0 {
 		chain.ID = apechain.ID(fmt.Sprintf("%s:%d", apechain.Ingress, s.apeChainCounter.Load()))
 	}
 
@@ -157,6 +180,37 @@ func (s *Server) RemoveChainLocalOverride(_ context.Context, req *control.Remove
 	return resp, nil
 }
 
+func (s *Server) ListTargetsLocalOverrides(_ context.Context, req *control.ListTargetsLocalOverridesRequest) (*control.ListTargetsLocalOverridesResponse, error) {
+	if err := s.isValidRequest(req); err != nil {
+		return nil, status.Error(codes.PermissionDenied, err.Error())
+	}
+
+	apeChainName := apechain.Name(req.GetBody().GetChainName())
+	apeTargets, err := s.localOverrideStorage.LocalStorage().ListOverrideDefinedTargets(apeChainName)
+	if err != nil {
+		return nil, status.Error(getCodeByLocalStorageErr(err), err.Error())
+	}
+	targets := make([]*control.ChainTarget, 0, len(apeTargets))
+	for i := range apeTargets {
+		target, err := controlTarget(&apeTargets[i])
+		if err != nil {
+			return nil, status.Error(codes.Internal, err.Error())
+		}
+		targets = append(targets, &target)
+	}
+
+	resp := &control.ListTargetsLocalOverridesResponse{
+		Body: &control.ListTargetsLocalOverridesResponse_Body{
+			Targets: targets,
+		},
+	}
+	err = SignMessage(s.key, resp)
+	if err != nil {
+		return nil, status.Error(codes.Internal, err.Error())
+	}
+	return resp, nil
+}
+
 func getCodeByLocalStorageErr(err error) codes.Code {
 	if errors.Is(err, engine.ErrChainNotFound) || errors.Is(err, engine.ErrChainNameNotFound) {
 		return codes.NotFound

pkg/services/control/service.proto

@@ -57,6 +57,9 @@ service ControlService {
     // Remove local access policy engine overrides stored in the node by chaind id.
     rpc RemoveChainLocalOverride (RemoveChainLocalOverrideRequest) returns (RemoveChainLocalOverrideResponse);
 
+    // List targets of the local APE overrides stored in the node.
+    rpc ListTargetsLocalOverrides (ListTargetsLocalOverridesRequest) returns (ListTargetsLocalOverridesResponse);
+
     // Flush objects from write-cache and move it to degraded read only mode.
     rpc SealWriteCache(SealWriteCacheRequest) returns (SealWriteCacheResponse);
 }
@@ -505,6 +508,30 @@ message ListChainLocalOverridesResponse {
     Signature signature = 2;
 }
 
+// ListTargetsLocalOverrides request.
+message ListTargetsLocalOverridesRequest {
+    message Body {
+        // Target for which the overrides are applied.
+        string chainName = 1;
+    }
+
+    Body body = 1;
+
+    Signature signature = 2;
+}
+
+// ListTargetsLocalOverrides response.
+message ListTargetsLocalOverridesResponse {
+    message Body {
+        // The list of chain targets.
+        repeated ChainTarget targets = 1;
+    }
+
+    Body body = 1;
+
+    Signature signature = 2;
+}
+
 message RemoveChainLocalOverrideRequest {
     message Body {
         // Target for which the overrides are applied.
@@ -556,4 +583,4 @@ message SealWriteCacheResponse {
     Body body = 1;
 
     Signature signature = 2;
-}
+}