machine-db/client/cli/vlans.go

// Copyright 2017 The LUCI Authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package cli

import (
	"github.com/maruel/subcommands"

	"go.chromium.org/luci/common/cli"
	"go.chromium.org/luci/common/errors"
	"go.chromium.org/luci/common/flag"

	"go.chromium.org/luci/machine-db/api/crimson/v1"
)

// printVLANs prints VLAN data to stdout in tab-separated columns.
func printVLANs(tsv bool, vlans ...*crimson.VLAN) {
	if len(vlans) > 0 {
		p := newStdoutPrinter(tsv)
		defer p.Flush()
		if !tsv {
			p.Row("ID", "Alias", "Description", "State", "CIDR Block")
		}
		for _, v := range vlans {
			p.Row(v.Id, v.Alias, v.Description, v.State, v.CidrBlock)
		}
	}
}

// GetVLANsCmd is the command to get VLANs.
type GetVLANsCmd struct {
	commandBase
	req crimson.ListVLANsRequest
}

// Run runs the command to get VLANs.
func (c *GetVLANsCmd) Run(app subcommands.Application, args []string, env subcommands.Env) int {
	ctx := cli.GetContext(app, c, env)
	client := getClient(ctx)
	resp, err := client.ListVLANs(ctx, &c.req)
	if err != nil {
		errors.Log(ctx, err)
		return 1
	}
	printVLANs(c.f.tsv, resp.Vlans...)
	return 0
}

// getVLANsCmd returns a command to get VLANs.
func getVLANsCmd(params *Parameters) *subcommands.Command {
	return &subcommands.Command{
		UsageLine: "get-vlans [-id <id>]... [-alias <alias>]...",
		ShortDesc: "retrieves VLANs",
		LongDesc:  "Retrieves VLANs matching the given IDs or aliases, or all VLANs if IDs and aliases are omitted.\n\nExample to get all VLANs:\ncrimson get-vlans\nExample to get VLAN 1:\ncrimson get-vlans -id 1",
		CommandRun: func() subcommands.CommandRun {
			cmd := &GetVLANsCmd{}
			cmd.Initialize(params)
			cmd.Flags.Var(flag.Int64Slice(&cmd.req.Ids), "id", "ID of a VLAN to filter by. Can be specified multiple times.")
			cmd.Flags.Var(flag.StringSlice(&cmd.req.Aliases), "alias", "Alias of a VLAN to filter by. Can be specified multiple times.")
			return cmd
		},
	}
}