Merge pull request #5 from chermehdi/custom-case

Custom user test case command

Author: chermehdi

.gitignore

@@ -1 +1,2 @@
 .idea
+go.sum

commands/case.go

@@ -0,0 +1,149 @@
+package commands
+
+import (
+	"bufio"
+	"fmt"
+	"github.com/chermehdi/egor/config"
+	"github.com/fatih/color"
+	"github.com/urfave/cli/v2"
+	"os"
+	"path"
+	"strconv"
+)
+
+// Read from stdin till ctrl D or Command D
+func readFromStdin() []string {
+	scn := bufio.NewScanner(os.Stdin)
+	var lines []string
+	for scn.Scan() {
+		line := scn.Text()
+		if len(line) == 1 {
+			if line[0] == '\x1D' {
+				break
+			}
+		}
+		lines = append(lines, line)
+	}
+	return lines
+}
+
+// Write given lines to given filename
+func writeLinesToFile(filename string, lines []string) error {
+	f, err := os.Create(filename)
+	if err != nil {
+		return err
+	}
+
+	for _, line := range lines {
+		fmt.Fprintln(f, line)
+		if err != nil {
+			return err
+		}
+	}
+
+	return nil
+}
+
+// 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) {
+
+	inputFileName := caseName + ".in"
+	err := writeLinesToFile(path.Join("inputs", inputFileName), inputLines)
+	if err != nil {
+		return metaData, err
+	}
+	inputFile := config.NewIoFile(inputFileName, path.Join("inputs", inputFileName), true)
+	metaData.Inputs = append(metaData.Inputs, inputFile)
+
+	return metaData, nil
+}
+
+// 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) {
+
+	outputFileName := caseName + ".ans"
+	err := writeLinesToFile(path.Join("outputs", outputFileName), outputLines)
+	if err != nil {
+		return metaData, err
+	}
+	outputFile := config.NewIoFile(outputFileName, path.Join("outputs", outputFileName), true)
+	metaData.Outputs = append(metaData.Outputs, outputFile)
+
+	return metaData, nil
+}
+
+// Create a user custom test case
+func CustomCaseAction(context *cli.Context) error {
+	color.Green("Creating Custom Test Case...")
+
+	// Load meta data
+	cwd, err := os.Getwd()
+	if err != nil {
+		color.Red("Failed to Generate Custom Case")
+		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
+	}
+
+	caseName := "test-" + strconv.Itoa(len(metaData.Inputs))
+	color.Green("Provide your input:")
+	inputLines := readFromStdin()
+	metaData, err = AddNewCaseInput(inputLines, caseName, metaData)
+
+	if err != nil {
+		color.Red("Failed to add new case input")
+		return err
+	}
+
+	if !context.Bool("no-output") {
+		color.Green("Provide your output:")
+		outputLines := readFromStdin()
+		metaData, err = AddNewCaseOutput(outputLines, caseName, metaData)
+
+		if err != nil {
+			color.Red("Failed to add new case output")
+			return err
+		}
+	}
+
+	metaData.SaveToFile(path.Join(cwd, configFileName))
+
+	if err != nil {
+		color.Red("Failed to save to MetaData")
+		return err
+	}
+
+	color.Green("Created Custom Test Case")
+	return nil
+}
+
+var CaseCommand = cli.Command{
+	Name:      "case",
+	Aliases:   []string{"tc", "testcase"},
+	Usage:     "Create a custom test case.",
+	UsageText: "Add custom test cases to egor task.",
+	Action:    CustomCaseAction,
+	Flags: []cli.Flag{
+		&cli.BoolFlag{
+			Name:  "no-output",
+			Usage: "This test case doesnt have output",
+			Value: false,
+		},
+	},
+}

commands/case_test.go

@@ -0,0 +1,75 @@
+package commands
+
+import (
+	"github.com/chermehdi/egor/config"
+	"github.com/stretchr/testify/assert"
+	"os"
+	"testing"
+)
+
+
+func createDummyMetaData() (config.EgorMeta) {
+	meteData := config.EgorMeta {
+		TaskName:	"Dummy Task",
+		TaskLang: 	"cpp",
+		Inputs: 	[]config.IoFile {
+			config.IoFile {
+				Name: 	"test-0",
+				Path: 	"inputs/test-0.in",
+				Custom:	false, 
+			}, 
+			config.IoFile {
+				Name: 	"test-1",
+				Path: 	"inputs/test-1.in",
+				Custom:	true,
+			}, 
+		}, 
+		Outputs: 	[]config.IoFile {
+			config.IoFile {
+				Name: 	"test-0",
+				Path: 	"outputs/test-0.ans",
+				Custom:	false,
+			},
+		},
+	}
+
+	return meteData
+}
+
+
+func TestAddNewCaseInput(t *testing.T) {
+	meteData := createDummyMetaData()
+
+	// create temp inputs directory
+	_ = os.Mkdir("inputs", 0777)
+	defer DeleteDir("inputs")
+
+	inputLines := []string{"Hello", "World"}
+	caseName := "test-2"
+	meteData, err := AddNewCaseInput(inputLines, caseName, meteData)
+
+	assert.Equal(t, err, nil)
+	assert.Equal(t, len(meteData.Inputs), 3)
+	assert.Equal(t, meteData.Inputs[2].Name, caseName + ".in")
+	assert.Equal(t, meteData.Inputs[2].Custom, true)
+	
+}
+
+
+func TestAddNewCaseOutput(t *testing.T) {
+	meteData := createDummyMetaData()
+
+	// create temp outputs directory
+	_ = os.Mkdir("outputs", 0777)
+	defer DeleteDir("outputs")
+
+	outputLines := []string{"Hello", "World"}
+	caseName := "test-2"
+	meteData, err := AddNewCaseOutput(outputLines, caseName, meteData)
+
+	assert.Equal(t, err, nil)
+	assert.Equal(t, len(meteData.Outputs), 2)
+	assert.Equal(t, meteData.Outputs[1].Name, caseName + ".ans")
+	assert.Equal(t, meteData.Outputs[1].Custom, true)
+
+}

commands/parse.go

@@ -30,9 +30,6 @@ func SerializeTask(meta EgorMeta) (string, error) {
 	return buffer.String(), nil
 }
 
-func CreateFile(filePath string) (*os.File, error) {
-	return os.OpenFile(filePath, os.O_TRUNC|os.O_CREATE|os.O_WRONLY, 0777)
-}
 
 func CreateDirectoryStructure(task Task, config Config, rootDir string) (string, error) {
 	taskDir := path.Join(rootDir, task.Name)

config/meta.go

@@ -6,18 +6,21 @@ import (
 	"errors"
 	"fmt"
 	"io"
+	"os"
 	"path"
 )
 
 type IoFile struct {
-	Name string
-	Path string
+	Name   		string
+	Path   		string
+	Custom 		bool
 }
 
-func NewIoFile(fileName, filePath string) IoFile {
+func NewIoFile(fileName, filePath string, customCase bool) IoFile {
 	return IoFile{
-		Name: fileName,
-		Path: filePath,
+		Name:   	fileName,
+		Path:   	filePath,
+		Custom: 	customCase,
 	}
 }
 
@@ -53,8 +56,8 @@ func NewEgorMeta(task Task, config Config) EgorMeta {
 	outputs := make([]IoFile, testCount)
 	for i := 0; i < testCount; i++ {
 		fileName := fmt.Sprintf("test-%d", i)
-		inputs[i] = NewIoFile(fileName, path.Join("inputs", fileName+".in"))
-		outputs[i] = NewIoFile(fileName, path.Join("outputs", fileName+".ans"))
+		inputs[i] = NewIoFile(fileName, path.Join("inputs", fileName+".in"), false)
+		outputs[i] = NewIoFile(fileName, path.Join("outputs", fileName+".ans"), false)
 	}
 	taskFile, err := GetTaskName(config)
 	if err != nil {
@@ -86,9 +89,40 @@ func (egor *EgorMeta) Save(w io.Writer) error {
 	return err
 }
 
+func (egor *EgorMeta) SaveToFile(filePath string) error {
+	file, _ := CreateFile(filePath)
+	return egor.Save(file)
+}
+
 // TODO(chermehdi): probably this should't be a member function
 func (egor *EgorMeta) Load(r io.Reader) error {
 	decoder := json2.NewDecoder(r)
 	err := decoder.Decode(egor)
 	return err
 }
+
+// Load egor meta data from a given reader
+func LoadMeta(r io.Reader) (EgorMeta, error) {
+	var egor_meta EgorMeta
+	decoder := json2.NewDecoder(r)
+	err := decoder.Decode(&egor_meta)
+	return egor_meta, err
+}
+
+// Load egor meta data form a filepath
+func LoadMetaFromPath(filePath string) (EgorMeta, error) {
+	file, _ := OpenFileFromPath(filePath)
+	return LoadMeta(file)
+}
+
+// TODO(Eroui): this is a duplicate function from parse.go
+// consider moving this somewhere common or use the other one
+func CreateFile(filePath string) (*os.File, error) {
+	return os.OpenFile(filePath, os.O_TRUNC|os.O_CREATE|os.O_WRONLY, 0777)
+}
+
+// Open file with a given file path
+func OpenFileFromPath(filePath string) (*os.File, error) {
+	file, err := os.Open(filePath)
+	return file, err
+}

main.go

@@ -5,7 +5,6 @@ import (
 	"html/template"
 	"log"
 	"os"
-
 	"github.com/chermehdi/egor/commands"
 	"github.com/chermehdi/egor/config"
 	"github.com/urfave/cli/v2"
@@ -44,6 +43,7 @@ func main() {
 		Commands: []*cli.Command{
 			&commands.ParseCommand,
 			&commands.ConfigCommand,
+			&commands.CaseCommand,
 		},
 	}