Extract logic for parsing Symfony CLI apps

fabpot · fabpot · commit 333d8456465d · 2025-02-18T08:44:31.000+01:00
diff --git a/local/platformsh/generator/commands.go b/local/platformsh/generator/commands.go
@@ -11,44 +11,11 @@ import (
 	"text/template"
 
 	"github.com/mitchellh/go-homedir"
-	"github.com/pkg/errors"
 	"github.com/symfony-cli/console"
 	"github.com/symfony-cli/symfony-cli/local/platformsh"
+	"github.com/symfony-cli/symfony-cli/symfony"
 )
 
-type application struct {
-	Namespaces []namespace
-	Commands   []command
-}
-
-type namespace struct {
-	ID       string
-	Commands []string
-}
-
-type command struct {
-	Name        string
-	Usage       []string
-	Description string
-	Help        string
-	Definition  definition
-	Hidden      bool
-	Aliases     []string
-}
-
-type definition struct {
-	Arguments map[string]argument
-	Options   map[string]option
-}
-
-type argument struct {
-}
-
-type option struct {
-	Shortcut string
-	Default  interface{}
-}
-
 var commandsTemplate = template.Must(template.New("output").Parse(`// Code generated by platformsh/generator/main.go
 // DO NOT EDIT
 
@@ -112,20 +79,12 @@ func generateCommands() {
 }
 
 func parseCommands(cloudPath string) (string, error) {
-	var buf bytes.Buffer
-	var bufErr bytes.Buffer
-	cmd := exec.Command(cloudPath, "list", "--format=json", "--all")
-	cmd.Stdout = &buf
-	cmd.Stderr = &bufErr
-	if err := cmd.Run(); err != nil {
-		return "", errors.Errorf("unable to list commands: %s\n%s\n%s", err, bufErr.String(), buf.String())
+	wd, err := os.Getwd()
+	if err != nil {
+		return "", err
 	}
-
-	// Fix PHP types
-	cleanOutput := bytes.ReplaceAll(buf.Bytes(), []byte(`"arguments":[]`), []byte(`"arguments":{}`))
-
-	var definition application
-	if err := json.Unmarshal(cleanOutput, &definition); err != nil {
+	cliApp, err := symfony.NewGoCliApp(wd, cloudPath, []string{"--all"})
+	if err != nil {
 		return "", err
 	}
 
@@ -147,7 +106,7 @@ func parseCommands(cloudPath string) (string, error) {
 	excludedOptions = append(excludedOptions, console.VersionFlag.Names()...)
 
 	definitionAsString := ""
-	for _, command := range definition.Commands {
+	for _, command := range cliApp.Commands {
 		if strings.Contains(command.Description, "deprecated") || strings.Contains(command.Description, "DEPRECATED") {
 			continue
 		}
@@ -162,7 +121,7 @@ func parseCommands(cloudPath string) (string, error) {
 		}
 		namespace := "cloud"
 	loop:
-		for _, n := range definition.Namespaces {
+		for _, n := range cliApp.Namespaces {
 			for _, name := range n.Commands {
 				if name == command.Name {
 					if n.ID != "_global" {
@@ -282,7 +241,7 @@ func getCommandAliases(name, cloudPath string) ([]string, error) {
 		return []string{}, nil
 		//return nil, errors.Errorf("unable to get definition for command %s: %s\n%s\n%s", name, err, bufErr.String(), buf.String())
 	}
-	var cmd command
+	var cmd symfony.CliCommand
 	if err := json.Unmarshal(buf.Bytes(), &cmd); err != nil {
 		return nil, err
 	}
diff --git a/symfony/cli.go b/symfony/cli.go
@@ -0,0 +1,112 @@
+/*
+ * Copyright (c) 2021-present Fabien Potencier <fabien@symfony.com>
+ *
+ * This file is part of Symfony CLI project
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+package symfony
+
+import (
+	"bytes"
+	"encoding/json"
+	"fmt"
+	"os/exec"
+	"strings"
+
+	"github.com/pkg/errors"
+	"github.com/symfony-cli/symfony-cli/local/php"
+)
+
+type CliApp struct {
+	Commands   []CliCommand
+	Namespaces []CliNamespace
+}
+
+type CliNamespace struct {
+	ID       string
+	Commands []string
+}
+
+type CliCommand struct {
+	Name        string
+	Usage       []string
+	Description string
+	Help        string
+	Definition  CliDefinition
+	Hidden      bool
+	Aliases     []string
+}
+
+type CliDefinition struct {
+	Arguments map[string]CliArgument
+	Options   map[string]CliOption
+}
+
+type CliArgument struct {
+	Required    bool        `json:"is_required"`
+	IsArray     bool        `json:"is_array"`
+	Description string      `json:"description"`
+	Default     interface{} `json:"default"`
+}
+
+type CliOption struct {
+	Shortcut        string      `json:"shortcut"`
+	Description     string      `json:"description"`
+	AcceptValue     bool        `json:"accept_value"`
+	IsValueRequired bool        `json:"is_value_required"`
+	IsMultiple      bool        `json:"is_multiple"`
+	Default         interface{} `json:"default"`
+}
+
+func NewCliApp(projectDir string, args []string) (*CliApp, error) {
+	args = append(args, "list", "--format=json")
+	var buf bytes.Buffer
+	e := &php.Executor{
+		BinName: "php",
+		Dir:     projectDir,
+		Args:    args,
+		Stdout:  &buf,
+		Stderr:  &buf,
+	}
+	if ret := e.Execute(false); ret != 0 {
+		return nil, errors.Errorf("unable to list commands (%s):\n%s", strings.Join(args, " "), buf.String())
+	}
+	return parseCommands(buf.Bytes())
+}
+
+func NewGoCliApp(projectDir string, binPath string, args []string) (*CliApp, error) {
+	var buf bytes.Buffer
+	cmd := exec.Command(binPath, "list", "--format=json")
+	cmd.Args = append(cmd.Args, args...)
+	fmt.Println(cmd.Args)
+	cmd.Dir = projectDir
+	cmd.Stdout = &buf
+	cmd.Stderr = &buf
+	if err := cmd.Run(); err != nil {
+		return nil, errors.Errorf("unable to list commands (%s):\n%s\n%s", strings.Join(args, " "), err, buf.String())
+	}
+	return parseCommands(buf.Bytes())
+}
+
+func parseCommands(output []byte) (*CliApp, error) {
+	// Fix PHP types
+	cleanOutput := bytes.ReplaceAll(output, []byte(`"arguments":[]`), []byte(`"arguments":{}`))
+	var app *CliApp
+	if err := json.Unmarshal(cleanOutput, &app); err != nil {
+		return nil, err
+	}
+	return app, nil
+}
