Files
seaweedfs/weed/shell/command_s3_bucket_quota.go
T
bac2196d65 shell: return flag parse errors from every command (#12618)
* shell: return flag parse errors from every command

48 commands returned nil when their flags failed to parse, so a mistyped
flag printed the flag error but the command still counted as a success:
a piped weed shell run exited 0, the master maintenance loop logged no
error, and admin script jobs reported the line as done.

Return the parse error as s3.bucket.create (#12544) and the other shell
commands already do. TestCommandsReturnFlagParseErrors runs every
registered command with an unknown flag and fails for the 48 on master.

Signed-off-by: anant <170962632+antcybersec@users.noreply.github.com>

* shell: don't report -h as a failure

With the parse errors returned, -h on those commands now returns
flag.ErrHelp, so the shell printed "error: flag: help requested" and a
piped run exited 1. The flag package has already printed the usage, so
processEachCmd now treats flag.ErrHelp as success for every command.

Signed-off-by: anant <170962632+antcybersec@users.noreply.github.com>

* shell: keep the -h test beside the flag parse test

TestProcessEachCmdTreatsHelpAsSuccess covers the same change as
TestCommandsReturnFlagParseErrors, so it lives in the same new file and
shell_liner_test.go stays as it was.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

---------

Signed-off-by: anant <170962632+antcybersec@users.noreply.github.com>
Co-authored-by: anant <170962632+antcybersec@users.noreply.github.com>
Co-authored-by: Chris Lu <chrislusf@users.noreply.github.com>
Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-13 12:19:44 -08:00

121 lines
3.0 KiB
Go

package shell
import (
"context"
"flag"
"fmt"
"io"
"github.com/seaweedfs/seaweedfs/weed/filer"
"github.com/seaweedfs/seaweedfs/weed/pb/filer_pb"
)
func init() {
Commands = append(Commands, &commandS3BucketQuota{})
}
type commandS3BucketQuota struct {
}
func (c *commandS3BucketQuota) Name() string {
return "s3.bucket.quota"
}
func (c *commandS3BucketQuota) Help() string {
return `set/remove/enable/disable quota for a bucket
Example:
s3.bucket.quota -name=<bucket_name> -op=set -sizeMB=1024
Removing or disabling the quota also clears the read-only flag that
s3.bucket.quota.enforce may have set on the bucket.
`
}
func (c *commandS3BucketQuota) HasTag(CommandTag) bool {
return false
}
func (c *commandS3BucketQuota) Do(args []string, commandEnv *CommandEnv, writer io.Writer) (err error) {
bucketCommand := flag.NewFlagSet(c.Name(), flag.ContinueOnError)
bucketName := bucketCommand.String("name", "", "bucket name")
operationName := bucketCommand.String("op", "set", "operation name [set|get|remove|enable|disable]")
sizeMB := bucketCommand.Int64("sizeMB", 0, "bucket quota size in MiB")
if err = bucketCommand.Parse(args); err != nil {
return err
}
if *bucketName == "" {
return fmt.Errorf("empty bucket name")
}
err = commandEnv.WithFilerClient(false, func(client filer_pb.SeaweedFilerClient) error {
ctx := context.Background()
resp, err := client.GetFilerConfiguration(ctx, &filer_pb.GetFilerConfigurationRequest{})
if err != nil {
return fmt.Errorf("get filer configuration: %w", err)
}
filerBucketsPath := resp.DirBuckets
lookupResp, err := client.LookupDirectoryEntry(ctx, &filer_pb.LookupDirectoryEntryRequest{
Directory: filerBucketsPath,
Name: *bucketName,
})
if err != nil {
return fmt.Errorf("did not find bucket %s: %v", *bucketName, err)
}
bucketEntry := lookupResp.Entry
clearReadOnly := false
switch *operationName {
case "set":
bucketEntry.Quota = *sizeMB * 1024 * 1024
case "get":
fmt.Fprintf(writer, "bucket quota: %dMiB \n", bucketEntry.Quota/1024/1024)
return nil
case "remove":
bucketEntry.Quota = 0
clearReadOnly = true
case "enable":
if bucketEntry.Quota < 0 {
bucketEntry.Quota = -bucketEntry.Quota
}
case "disable":
if bucketEntry.Quota > 0 {
bucketEntry.Quota = -bucketEntry.Quota
}
clearReadOnly = true
}
if err := filer_pb.UpdateEntry(context.Background(), client, &filer_pb.UpdateEntryRequest{
Directory: filerBucketsPath,
Entry: bucketEntry,
}); err != nil {
return err
}
println("updated quota for bucket", *bucketName)
if clearReadOnly {
// with the quota removed or disabled, s3.bucket.quota.enforce can no
// longer clear a read-only flag it turned on, so lift it here
cleared, err := filer.ClearBucketReadOnly(ctx, client, filerBucketsPath, *bucketName)
if err != nil {
return err
}
if cleared {
fmt.Fprintf(writer, "cleared read-only for bucket %s\n", *bucketName)
}
}
return nil
})
return err
}