details.go

// This file is part of arduino-cli.
//
// Copyright 2020 ARDUINO SA (http://www.arduino.cc/)
//
// This software is released under the GNU General Public License version 3,
// which covers the main part of arduino-cli.
// The terms of this license can be found at:
// https://www.gnu.org/licenses/gpl-3.0.en.html
//
// You can be released from the requirements of the above licenses by purchasing
// a commercial license. Buying such a license is mandatory if you want to
// modify or otherwise use the software for commercial activities involving the
// Arduino software without disclosing the source code of your own applications.
// To purchase a commercial license, send an email to license@arduino.cc.

package board

import (
	"context"
	"fmt"
	"os"

	"github.com/arduino/arduino-cli/internal/cli/arguments"
	"github.com/arduino/arduino-cli/internal/cli/feedback"
	"github.com/arduino/arduino-cli/internal/cli/feedback/result"
	"github.com/arduino/arduino-cli/internal/cli/feedback/table"
	"github.com/arduino/arduino-cli/internal/cli/instance"
	"github.com/arduino/arduino-cli/internal/i18n"
	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
	"github.com/fatih/color"
	"github.com/sirupsen/logrus"
	"github.com/spf13/cobra"
)

func initDetailsCommand(srv rpc.ArduinoCoreServiceServer) *cobra.Command {
	var showFullDetails bool
	var listProgrammers bool
	var fqbn arguments.Fqbn
	var showProperties arguments.ShowProperties
	var detailsCommand = &cobra.Command{
		Use:     fmt.Sprintf("details -b <%s>", i18n.Tr("FQBN")),
		Short:   i18n.Tr("Print details about a board."),
		Long:    i18n.Tr("Show information about a board, in particular if the board has options to be specified in the FQBN."),
		Example: "  " + os.Args[0] + " board details -b arduino:avr:nano",
		Args:    cobra.NoArgs,
		Run: func(cmd *cobra.Command, args []string) {
			runDetailsCommand(cmd.Context(), srv, fqbn.String(), showFullDetails, listProgrammers, showProperties)
		},
	}

	fqbn.AddToCommand(detailsCommand, srv)
	detailsCommand.Flags().BoolVarP(&showFullDetails, "full", "f", false, i18n.Tr("Show full board details"))
	detailsCommand.Flags().BoolVarP(&listProgrammers, "list-programmers", "", false, i18n.Tr("Show list of available programmers"))
	detailsCommand.MarkFlagRequired("fqbn")
	showProperties.AddToCommand(detailsCommand)
	return detailsCommand
}

func runDetailsCommand(ctx context.Context, srv rpc.ArduinoCoreServiceServer, fqbn string, showFullDetails, listProgrammers bool, showProperties arguments.ShowProperties) {
	inst := instance.CreateAndInit(ctx, srv)

	logrus.Info("Executing `arduino-cli board details`")

	showPropertiesMode, err := showProperties.Get()
	if err != nil {
		feedback.Fatal(err.Error(), feedback.ErrBadArgument)
	}
	res, err := srv.BoardDetails(ctx, &rpc.BoardDetailsRequest{
		Instance:                   inst,
		Fqbn:                       fqbn,
		DoNotExpandBuildProperties: showPropertiesMode == arguments.ShowPropertiesUnexpanded,
	})
	if err != nil {
		feedback.Fatal(i18n.Tr("Error getting board details: %v", err), feedback.ErrGeneric)
	}

	feedback.PrintResult(detailsResult{
		details:         result.NewBoardDetailsResponse(res),
		listProgrammers: listProgrammers,
		showFullDetails: showFullDetails,
		showProperties:  showPropertiesMode != arguments.ShowPropertiesDisabled,
	})
}

// output from this command requires special formatting, let's create a dedicated
// feedback.Result implementation
type detailsResult struct {
	details         *result.BoardDetailsResponse
	listProgrammers bool
	showFullDetails bool
	showProperties  bool
}

func (dr detailsResult) Data() interface{} {
	return dr.details
}

func (dr detailsResult) String() string {
	details := dr.details

	if dr.showProperties {
		res := ""
		for _, prop := range details.BuildProperties {
			res += fmt.Sprintln(prop)
		}
		return res
	}

	if dr.listProgrammers {
		t := table.New()
		t.AddRow(i18n.Tr("Id"), i18n.Tr("Programmer name"))
		for _, programmer := range details.Programmers {
			t.AddRow(programmer.Id, programmer.Name)
		}
		return t.Render()
	}

	// Table is 4 columns wide:
	// |               |                             | |                       |
	// Board name:     Arduino Nano
	//
	// Required tools: arduino:avr-gcc                 5.4.0-atmel3.6.1-arduino2
	//                 arduino:avrdude                 6.3.0-arduino14
	//                 arduino:arduinoOTA              1.2.1
	//
	// Option:         Processor                       cpu
	//                 ATmega328P                    ✔ cpu=atmega328
	//                 ATmega328P (Old Bootloader)     cpu=atmega328old
	//                 ATmega168                       cpu=atmega168
	t := table.New()
	tab := table.New()
	addIfNotEmpty := func(label, content string) {
		if content != "" {
			t.AddRow(label, content)
		}
	}

	t.SetColumnWidthMode(1, table.Average)
	t.AddRow(i18n.Tr("Board name:"), details.Name)
	t.AddRow(i18n.Tr("FQBN:"), details.Fqbn)
	addIfNotEmpty(i18n.Tr("Board version:"), details.Version)

	if details.Official {
		t.AddRow() // get some space from above
		t.AddRow(i18n.Tr("Official Arduino board:"),
			table.NewCell("✔", color.New(color.FgGreen)))
	}

	for _, idp := range details.IdentificationProperties {
		if idp.Properties == nil {
			continue
		}
		t.AddRow() // get some space from above
		header := i18n.Tr("Identification properties:")
		keys := idp.Properties.Keys()
		for _, k := range keys {
			t.AddRow(header, k+"="+idp.Properties.Get(k))
			header = ""
		}
	}

	t.AddRow() // get some space from above
	addIfNotEmpty(i18n.Tr("Package name:"), details.Package.Name)
	addIfNotEmpty(i18n.Tr("Package maintainer:"), details.Package.Maintainer)
	addIfNotEmpty(i18n.Tr("Package URL:"), details.Package.Url)
	addIfNotEmpty(i18n.Tr("Package website:"), details.Package.WebsiteUrl)
	addIfNotEmpty(i18n.Tr("Package online help:"), details.Package.Help.Online)

	t.AddRow() // get some space from above
	addIfNotEmpty(i18n.Tr("Platform name:"), details.Platform.Name)
	addIfNotEmpty(i18n.Tr("Platform category:"), details.Platform.Category)
	addIfNotEmpty(i18n.Tr("Platform architecture:"), details.Platform.Architecture)
	addIfNotEmpty(i18n.Tr("Platform URL:"), details.Platform.Url)
	addIfNotEmpty(i18n.Tr("Platform file name:"), details.Platform.ArchiveFilename)
	if details.Platform.Size != 0 {
		addIfNotEmpty(i18n.Tr("Platform size (bytes):"), fmt.Sprint(details.Platform.Size))
	}
	addIfNotEmpty(i18n.Tr("Platform checksum:"), details.Platform.Checksum)

	t.AddRow() // get some space from above

	tab.SetColumnWidthMode(1, table.Average)
	for _, tool := range details.ToolsDependencies {
		tab.AddRow(i18n.Tr("Required tool:"), tool.Packager+":"+tool.Name, tool.Version)
		if dr.showFullDetails {
			for _, sys := range tool.Systems {
				tab.AddRow("", i18n.Tr("OS:"), sys.Host)
				tab.AddRow("", i18n.Tr("File:"), sys.ArchiveFilename)
				tab.AddRow("", i18n.Tr("Size (bytes):"), fmt.Sprint(sys.Size))
				tab.AddRow("", i18n.Tr("Checksum:"), sys.Checksum)
				tab.AddRow("", i18n.Tr("URL:"), sys.Url)
				tab.AddRow() // get some space from above
			}
		}
	}

	green := color.New(color.FgGreen)
	tab.AddRow() // get some space from above
	for _, option := range details.ConfigOptions {
		tab.AddRow(i18n.Tr("Option:"), option.OptionLabel, "", option.Option)
		for _, value := range option.Values {
			if value.Selected {
				tab.AddRow("",
					table.NewCell(value.ValueLabel, green),
					table.NewCell("✔", green),
					table.NewCell(option.Option+"="+value.Value, green))
			} else {
				tab.AddRow("",
					value.ValueLabel,
					"",
					option.Option+"="+value.Value)
			}
		}
	}

	tab.AddRow(i18n.Tr("Programmers:"), i18n.Tr("ID"), i18n.Tr("Name"), "")
	for _, programmer := range details.Programmers {
		if programmer.Id == details.DefaultProgrammerID {
			tab.AddRow("", table.NewCell(programmer.Id, green), table.NewCell(programmer.Name, green), table.NewCell("✔ (default)", green))
		} else {
			tab.AddRow("", programmer.Id, programmer.Name)
		}
	}

	return t.Render() + tab.Render()
}