Merge pull request #10 from chermehdi/feature/show-cases

Feature/show cases

Author: chermehdi

commands/case.go

@@ -44,7 +44,7 @@ func writeLinesToFile(filename string, lines []string) error {
 	return nil
 }
 
-// Create and save user specified custom case input, and update the given egor meta data 
+// Create and save user specified custom case input, and update the given egor meta data
 func AddNewCaseInput(inputLines []string,
 	caseName string,
 	metaData config.EgorMeta) (config.EgorMeta, error) {
@@ -60,7 +60,7 @@ func AddNewCaseInput(inputLines []string,
 	return metaData, nil
 }
 
-// Create and save user specified custom csae output, and update the given egor meta data 
+// Create and save user specified custom csae output, and update the given egor meta data
 func AddNewCaseOutput(outputLines []string,
 	caseName string,
 	metaData config.EgorMeta) (config.EgorMeta, error) {
@@ -87,14 +87,13 @@ func CustomCaseAction(context *cli.Context) error {
 		return err
 	}
 
-	
 	configuration, err := config.LoadDefaultConfiguration()
 	if err != nil {
 		color.Red("Failed to load egor configuration")
 		return err
 	}
 
-  configFileName := configuration.ConfigFileName
+	configFileName := configuration.ConfigFileName
 	metaData, err := config.LoadMetaFromPath(path.Join(cwd, configFileName))
 	if err != nil {
 		color.Red("Failed to load egor MetaData ")
@@ -133,6 +132,12 @@ func CustomCaseAction(context *cli.Context) error {
 	return nil
 }
 
+// Command to add costum test cases to the current task.
+// Running this command will ask the user to provide their input and output, then 
+// saves the new test case data into appropriate files and add their meta data into
+// the current task egor meta data.
+// The user can add a flag --no-output to specify that this test case have no output 
+// associated with it. The user will not be asked to provide output in this case.
 var CaseCommand = cli.Command{
 	Name:      "case",
 	Aliases:   []string{"tc", "testcase"},

commands/showcases.go

@@ -0,0 +1,107 @@
+package commands
+
+import (
+	"github.com/chermehdi/egor/config"
+	"github.com/fatih/color"
+	"github.com/jedib0t/go-pretty/table"
+	"github.com/urfave/cli/v2"
+	"os"
+	"path"
+)
+
+type TestCaseIO struct {
+	Id int
+	Name string
+	InputPath string
+	OutputPath string
+	Custom bool
+}
+
+// parse input and output from egor meta to TestCase
+func GetTestCases(egorMeta config.EgorMeta) []*TestCaseIO {
+	testCasesMap := make(map[string]*TestCaseIO)
+	testCases := make([]*TestCaseIO, 0)
+	for _, input := range egorMeta.Inputs {
+		testCase := &TestCaseIO {
+			Id : input.GetId(),
+			Name : input.Name,
+			InputPath : input.Path,
+			OutputPath: "",
+			Custom: input.Custom,
+		}
+		testCasesMap[input.Name] = testCase
+		testCases = append(testCases, testCase)
+	}
+
+	for _, output := range egorMeta.Outputs {
+		if testCase, ok := testCasesMap[output.Name]; ok {
+			testCase.OutputPath = output.Path
+		}
+	}
+
+	return testCases
+}
+
+// print test cases table
+func PrintTestCasesTable(testCases []*TestCaseIO) {
+	t := table.NewWriter()
+	t.SetOutputMirror(os.Stdout)
+	t.AppendHeader(table.Row{"#", "Test Name", "Input Path", "Output Path", "Custon"})
+	for _, testCase := range testCases {
+		t.AppendRow([]interface{}{
+			testCase.Id,
+			testCase.Name,
+			testCase.InputPath,
+			testCase.OutputPath,
+			testCase.Custom,
+		})
+	}
+	t.SetStyle(table.StyleLight)
+	t.Render()
+}
+
+// print task test cases
+func PrintTestCases(egorMeta config.EgorMeta) {
+	PrintTestCasesTable(GetTestCases(egorMeta))
+}
+
+// list test cases information command action
+// TODO(Eroui): [Refactoring] Duplicate code while loading meta data, consider refactoring...
+func ShowCasesAction(context *cli.Context) error {
+	cwd, err := os.Getwd()
+	if err != nil {
+		color.Red("Failed to list test cases!")
+		return err
+	}
+
+	configuration, err := config.LoadDefaultConfiguration()
+	if err != nil {
+		color.Red("Failed to load egor configuration")
+		return err
+	}
+
+	configFileName := configuration.ConfigFileName
+	metaData, err := config.LoadMetaFromPath(path.Join(cwd, configFileName))
+	if err != nil {
+		color.Red("Failed to load egor MetaData ")
+		return err
+	}
+
+	color.Green("Listing %d testcase(s)...", metaData.CountTestCases())
+	color.Green("")
+	
+	PrintTestCases(metaData)
+
+	return nil
+}
+
+// Command to print the list of test cases input and outputs into the consol.
+// Running this command will fetch egor meta data and load all inputs and outputs meta data
+// and prints it as an array into the consol.
+var ShowCasesCommand = cli.Command{
+	Name:      "showcases",
+	Aliases:   []string{"sc"},
+	Usage:     "list information about test cases",
+	UsageText: "list meta data about of the tests cases in the current task",
+	Action:    ShowCasesAction,
+}

commands/showcases_test.go

@@ -0,0 +1,45 @@
+package commands
+
+import (
+	"github.com/chermehdi/egor/config"
+	"github.com/stretchr/testify/assert"
+	"testing"
+)
+
+func createSimpleDummyMetaData() config.EgorMeta{
+	meteData := config.EgorMeta {
+		TaskName:	"Dummy Task",
+		TaskLang: 	"cpp",
+		Inputs: 	[]config.IoFile {
+			config.IoFile {
+				Name: 	"test-0",
+				Path: 	"inputs/test-0.in",
+				Custom:	true, 
+			}, 
+		}, 
+		Outputs: 	[]config.IoFile {
+			config.IoFile {
+				Name: 	"test-0",
+				Path: 	"outputs/test-0.ans",
+				Custom:	true,
+			},
+		},
+	}
+
+	return meteData
+}
+
+func TestGetTestCases(t *testing.T) {
+	metaData := createDummyMetaData()
+	testCases := GetTestCases(metaData)
+	inputs := metaData.Inputs
+	outputs := metaData.Outputs
+
+	assert.Equal(t, len(testCases), len(metaData.Inputs))
+	assert.Equal(t, testCases[0].Id, inputs[0].GetId())
+	assert.Equal(t, testCases[0].Name, inputs[0].Name)
+	assert.Equal(t, testCases[0].Name, outputs[0].Name)
+	assert.Equal(t, testCases[0].InputPath, inputs[0].Path)
+	assert.Equal(t, testCases[0].OutputPath, outputs[0].Path)
+	assert.Equal(t, testCases[0].Custom, inputs[0].Custom)
+}

config/meta.go

@@ -8,6 +8,8 @@ import (
 	"io"
 	"os"
 	"path"
+	"strings"	
+	"strconv"
 )
 
 type IoFile struct {
@@ -24,6 +26,15 @@ func NewIoFile(fileName, filePath string, customCase bool) IoFile {
 	}
 }
 
+func (ioFile *IoFile) GetId() int {
+	tokens := strings.Split(ioFile.Name, "-")
+	id, err := strconv.Atoi(tokens[1])
+	if err != nil {
+		return 0 
+	}
+	return id
+}
+
 // Type mapping to the `egor-meta.json` file.
 // The egor meta configuration is the source of truth for the task runner
 // so an update to it (either from the outside, or by invoking egor commands) can change
@@ -71,6 +82,13 @@ func NewEgorMeta(task Task, config Config) EgorMeta {
 		TaskFile: taskFile,
 	}
 }
+
+// count the number of tests cases in the metadata. The number of tests is
+// the number of inputs
+func (egor *EgorMeta) CountTestCases() int {
+	return len(egor.Inputs)
+}
+
 func (egor *EgorMeta) toJson() (string, error) {
 	var buffer bytes.Buffer
 	encoder := json2.NewEncoder(&buffer)

main.go

@@ -44,6 +44,7 @@ func main() {
 			&commands.ParseCommand,
 			&commands.ConfigCommand,
 			&commands.CaseCommand,
+			&commands.ShowCasesCommand,
 		},
 	}