Initial refactor

Signed-off-by: Ulysses Souza <[email protected]>

Author: ulyssessouza

EnvLangFile.g4

@@ -1,17 +1,43 @@
 grammar EnvLangFile;
 
-envFile: NL* (entry NL*)+ ;
+envFile
+	: CRLF* (entry CRLF*)+
+	;
 
-entry : identifier (ASSIGN value | ASSIGN)? (NL* | EOF) ;
+entry
+	: identifier (ASSIGN value | ASSIGN)? (SPACE* CRLF* | EOF)
+	;
 
-identifier : TEXT;
+identifier
+	: TEXT
+	;
 
-value : op=(DQSTRING | SQSTRING | TEXT) ;
+value
+	: str=(DQSTRING | SQSTRING | TEXT)
+	;
 
-ASSIGN : '=';
-NL : '\r'? '\n';
-TEXT   : ~[=,\r\n"' ]~[=,\r\n"']* ;
-DQSTRING : '"' ('""'|~'"')* '"' ;
-SQSTRING : '\'' ('\'\''|~'\'')* '\'' ;
+ASSIGN
+	: '='
+	;
 
-SPACE : ' ' -> skip;
+CRLF
+	: '\r'? '\n'
+	| '\r'
+	;
+
+TEXT
+	: ~[=,\r\n"' ]~[=,\r\n"']*
+	;
+
+DQSTRING
+	: '"' ('""' | ~'"')* '"'
+	;
+
+SQSTRING
+	: '\'' ('\'\'' | ~'\'')* '\''
+	;
+
+SPACE
+	:
+	' ' -> skip
+	;

EnvLangValue.g4

@@ -1,36 +1,58 @@
 grammar EnvLangValue;
 
-dqstring : content* (CRLF* | EOF)  ;
+dqstring
+	: content* (SPACE* | CRLF* | EOF)
+	;
 
-strictVar : '${' TEXT_NO_SPACE+ '}';
-simpleVar : '$' TEXT_NO_SPACE+ ;
+variable
+	: var=(STRICT_VAR | SIMPLE_VAR)
+	;
 
-variable : strictVar | simpleVar ;
+content
+	: variable
+	| STR
+	| SPACE
+	| CRLF
+	;
 
-TEXT_NO_SPACE : [a-zA-Z0-9_] ;
-TEXT_ANY      : [a-zA-Z0-9_\n] ;
+STRICT_VAR
+	: '${' SPACE* VAR_ID SPACE* '}'
+	;
 
-text : TEXT_NO_SPACE TEXT_ANY* ;
+SIMPLE_VAR
+	: '$' VAR_ID
+	;
 
-space : ' ';
+STR
+	: FIRST_CHAR REST_OF_STRING*
+	;
 
-dQEscape : '""' ;
+SPACE
+	: ' '
+	| '\t'
+	;
 
-special
-    : '{'
-    | '}'
-    | '$'
-    ;
+CRLF
+	: '\r'? '\n'
+	| '\r'
+	;
 
-content
-    : dQEscape
-    | variable
-    | space
-    | special
-    | text
-    ;
+fragment FIRST_CHAR
+	: ~[,\\."'\r\n ]
+	;
+
+fragment REST_OF_STRING
+	: ~[\\'"$\r\n ]
+	;
+
+fragment VAR_ID
+	: [0-9]+ // Only numbers
+	| [a-zA-Z_][a-zA-Z_0-9]* // Start with letters, then letters, numbers and underscores
+	;
+
+// Catch all rule.
+// This is used to avoid the error message "no viable alternative at input '<EOF>'". Just for debugging.
+ANY
+	: .
+	;
 
-CRLF
-    : '\r'? '\n'
-    | '\r'
-    ;

Makefile

@@ -2,14 +2,19 @@ all: clean gen test
 	@echo "All done!"
 
 test:
-	@gotestsum --format testname ./...
+	@gotestsum --format testname -- -failfast ./...
 
 gen:
-	@antlr -Dlanguage=Go -o gen/fileparser -package fileparser EnvLangFile.g4
-	@antlr -Dlanguage=Go -o gen/valueparser -package valueparser EnvLangValue.g4
+	@antlr4 -Dlanguage=Go -o gen/fileparser -package fileparser EnvLangFile.g4
+	@antlr4 -Dlanguage=Go -o gen/valueparser -package valueparser EnvLangValue.g4
 
 clean:
 	@rm -rf gen
 
 setup:
 	go install gotest.tools/[email protected]
+
+grun:
+	antlr4 EnvLangValue.g4
+	javac -cp "/usr/share/java/antlr-4.13.1-complete.jar:$CLASSPATH" EnvLangValue*.java
+	java -Xmx500M -cp "/usr/share/java/antlr-4.13.1-complete.jar:$CLASSPATH" org.antlr.v4.gui.TestRig EnvLangValue dqstrings -tokens

dao/default_dao.go

@@ -10,12 +10,37 @@ var _ EnvLangDao = &DefaultDao{}
 type DefaultDao struct {
 	sync.RWMutex
 
-	m map[string]*string
+	env map[string]*string
+	m   map[string]*string
 }
 
 func NewDefaultDao() EnvLangDao {
 	return &DefaultDao{
-		m: make(map[string]*string),
+		m:   make(map[string]*string),
+		env: make(map[string]*string),
+	}
+}
+
+func NewDefaultDaoFromEnv(env []string) EnvLangDao {
+	d := &DefaultDao{
+		m:   make(map[string]*string),
+		env: make(map[string]*string),
+	}
+	for _, e := range env {
+		splitEnv := strings.SplitN(e, "=", 2)
+		v := splitEnv[1]
+		d.env[splitEnv[0]] = &v
+	}
+	return d
+}
+
+func NewDefaultDaoFromMap(env map[string]*string) EnvLangDao {
+	if env == nil {
+		env = make(map[string]*string)
+	}
+	return &DefaultDao{
+		m:   make(map[string]*string),
+		env: env,
 	}
 }
 
@@ -48,6 +73,9 @@ func (d *DefaultDao) Get(k string) (*string, bool) {
 	defer d.RUnlock()
 
 	v, ok := d.m[k]
+	if !ok {
+		v, ok = d.env[k]
+	}
 	return v, ok
 }
 

facade_test.go

@@ -9,6 +9,179 @@ import (
 	"github.com/ulyssessouza/envlang/dao"
 )
 
+func init() {
+	log.SetLevel(log.DebugLevel)
+}
+
+func TestGetValue(t *testing.T) {
+	tests := []struct {
+		name     string
+		input    string
+		expected map[string]*string
+		envState map[string]*string
+	}{
+		{
+			"Simple",
+			`A=aaa`,
+			map[string]*string{"A": strPtr("aaa")},
+			nil,
+		},
+		{
+			"SimpleWithSpaceBeforeAssign",
+			`A =aaa`,
+			map[string]*string{"A": strPtr("aaa")},
+			nil,
+		},
+		{
+			"SimpleWithSpaceAfterAssign",
+			`A= aaa`,
+			map[string]*string{"A": strPtr("aaa")},
+			nil,
+		},
+		{
+			"SimpleWithDoubleQuotes",
+			`A="aaa"`,
+			map[string]*string{"A": strPtr("aaa")},
+			nil,
+		},
+		{
+			"SimpleWithSingleQuotes",
+			`A='aaa'`,
+			map[string]*string{"A": strPtr("aaa")},
+			nil,
+		},
+		{
+			"SimpleWithDoubleQuotesAndSpaces",
+			`A=aaa bbb ccc`,
+			map[string]*string{"A": strPtr("aaa bbb ccc")},
+			nil,
+		},
+		{
+			"SimpleWithSingleQuotesAndSpaces",
+			`A='aaa bbb ccc'`,
+			map[string]*string{"A": strPtr("aaa bbb ccc")},
+			nil,
+		},
+		{
+			"SimpleWithDoubleQuotesAndSpaces",
+			`A="aaa bbb ccc"`,
+			map[string]*string{"A": strPtr("aaa bbb ccc")},
+			nil,
+		},
+		{
+			"MultiLine",
+			`
+A="my
+multi
+line
+entry"
+`,
+			map[string]*string{"A": strPtr("my\nmulti\nline\nentry")},
+			nil,
+		},
+		{
+			"VariableWithEquals",
+			`A=`,
+			map[string]*string{"A": strPtr("")},
+			nil,
+		},
+		{
+			"VariableOnly",
+			`A`,
+			map[string]*string{"A": nil},
+			nil,
+		},
+		{
+			"SimpleWithSpaces",
+			`
+A = aaa 
+`,
+			map[string]*string{"A": strPtr("aaa")},
+			nil,
+		},
+		{
+			"SimpleWithSimpleVariable",
+			`
+A=$VAR_FROM_DAO
+`,
+			map[string]*string{
+				"A": strPtr("aaa"),
+			},
+			map[string]*string{
+				"VAR_FROM_DAO": strPtr("aaa"),
+			},
+		},
+		{
+			"SimpleWithSimpleVariableWithSpaces",
+			`
+A = $VAR_FROM_DAO
+		`,
+			map[string]*string{
+				"A": strPtr("aaa"),
+			},
+			map[string]*string{
+				"VAR_FROM_DAO": strPtr("aaa"),
+			},
+		},
+		{
+			"SimpleWithStrictVariable",
+			`
+A=${VAR_FROM_DAO}
+`,
+			map[string]*string{
+				"A": strPtr("aaa"),
+			},
+			map[string]*string{
+				"VAR_FROM_DAO": strPtr("aaa"),
+			},
+		},
+		{
+			"SimpleWithStrictVariableWithSpaces",
+			`
+A = ${VAR_FROM_DAO}
+`,
+			map[string]*string{
+				"A": strPtr("aaa"),
+			},
+			map[string]*string{
+				"VAR_FROM_DAO": strPtr("aaa"),
+			},
+		},
+		{
+			"SimpleWithStrictVariableWithSpacesAndInternalSpaces",
+			`
+A = ${ VAR_FROM_DAO }
+`,
+			map[string]*string{
+				"A": strPtr("aaa"),
+			},
+			map[string]*string{
+				"VAR_FROM_DAO": strPtr("aaa"),
+			},
+		},
+
+		{
+			"DoubleQuotedWithMixedValue",
+			`
+A = "aaa ${B} ccc "
+`,
+			map[string]*string{
+				"A": strPtr("aaa bbb  ccc "),
+			},
+			map[string]*string{
+				"B": strPtr("bbb "),
+			},
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			d := dao.NewDefaultDaoFromMap(tt.envState)
+			assert.DeepEqual(t, tt.expected, GetVariables(d, tt.input))
+		})
+
+	}
+}
+
 func TestFull(t *testing.T) {
 	log.SetLevel(log.DebugLevel)
 	is := `
@@ -62,7 +235,7 @@ SPECIAL6 = "{{{ $$$ }}}"
 		"B":        strPtr("bbb"),
 		"C":        strPtr("ccc"),
 		"D":        strPtr("ddd"),
-		"E":        strPtr("'eee'"),
+		"E":        strPtr("eee"),
 		"F":        strPtr(""),
 		"G":        nil,
 		"H":        strPtr("my_value"),