Added unit-tests for the dhcpd configuration components in the vmware builder, and fixed a few discovered race conditions.

This commit is contained in:
Ali Rizvi-Santiago 2020-05-26 21:44:08 -05:00
parent 991511d08a
commit 7c1ad4adcf
3 changed files with 426 additions and 4 deletions

View File

@ -26,7 +26,10 @@ func uncomment(eof sentinelSignaller, in <-chan byte) (chan byte, sentinelSignal
select {
case <-eof:
stillReading = false
case ch := <-in:
case ch, ok := <-in:
if !ok {
break
}
switch ch {
case '#':
endofline = true
@ -47,7 +50,6 @@ func uncomment(eof sentinelSignaller, in <-chan byte) (chan byte, sentinelSignal
// convert a byte channel into a channel of pseudo-tokens
func tokenizeDhcpConfig(eof sentinelSignaller, in chan byte) (chan string, sentinelSignaller) {
var ch byte
var state string
var quote bool
@ -60,7 +62,10 @@ func tokenizeDhcpConfig(eof sentinelSignaller, in chan byte) (chan string, senti
case <-eof:
stillReading = false
case ch = <-in:
case ch, ok := <-in:
if !ok {
break
}
if quote {
if ch == '"' {
out <- state + string(ch)
@ -155,7 +160,11 @@ func (e *tkGroup) String() string {
func parseTokenParameter(in chan string) tkParameter {
var result tkParameter
for {
token := <-in
token, ok := <-in
if !ok {
goto leave
}
if result.name == "" {
result.name = token
continue
@ -187,6 +196,7 @@ func parseDhcpConfig(eof sentinelSignaller, in chan string) (tkGroup, error) {
out <- v
}
out <- ";"
close(out)
}(out)
return parseTokenParameter(out)
}

View File

@ -0,0 +1,392 @@
package common
import (
"testing"
"os"
"path/filepath"
)
func consumeString(s string) (out chan byte, eos sentinelSignaller) {
eos = make(sentinelSignaller)
out = make(chan byte)
go func() {
for _, ch := range s {
out <- byte(ch)
}
close(eos)
close(out)
}()
return
}
func uncommentFromString(s string) string {
inCh, eos := consumeString(s)
out, eoc := uncomment(eos, inCh)
result := ""
for reading := true; reading; {
select {
case <-eoc:
reading = false
case item, ok := <-out:
if ok {
result += string(item)
}
}
}
close(out)
return result
}
func TestParserUncomment(t *testing.T) {
var result string
test_0 := "this is a straight-up line"
result_0 := test_0
result = uncommentFromString(test_0)
if result != result_0 {
t.Errorf("Expected %#v, received %#v", result_0, result)
}
test_1 := "this is a straight-up line with a newline\n"
result_1 := test_1
result = uncommentFromString(test_1)
if result != result_1 {
t.Errorf("Expected %#v, received %#v", result_1, result)
}
test_2 := "this line has a comment # at its end"
result_2 := "this line has a comment "
result = uncommentFromString(test_2)
if result != result_2 {
t.Errorf("Expected %#v, received %#v", result_2, result)
}
test_3 := "# this whole line is commented"
result_3 := ""
result = uncommentFromString(test_3)
if result != result_3 {
t.Errorf("Expected %#v, received %#v", result_3, result)
}
test_4 := "this\nhas\nmultiple\nlines"
result_4 := test_4
result = uncommentFromString(test_4)
if result != result_4 {
t.Errorf("Expected %#v, received %#v", result_4, result)
}
test_5 := "this only has\n# one line"
result_5 := "this only has\n"
result = uncommentFromString(test_5)
if result != result_5 {
t.Errorf("Expected %#v, received %#v", result_5, result)
}
test_6 := "this is\npartially # commented"
result_6 := "this is\npartially "
result = uncommentFromString(test_6)
if result != result_6 {
t.Errorf("Expected %#v, received %#v", result_6, result)
}
test_7 := "this # has\nmultiple # lines\ncommented # out"
result_7 := "this \nmultiple \ncommented "
result = uncommentFromString(test_7)
if result != result_7 {
t.Errorf("Expected %#v, received %#v", result_7, result)
}
}
func tokenizeDhcpConfigFromString(s string) []string {
inCh, eos := consumeString(s)
out, eoc := tokenizeDhcpConfig(eos, inCh)
result := make([]string, 0)
for reading := true; reading; {
select {
case <-eoc:
reading = false
case item, ok := <-out:
if ok {
result = append(result, item)
}
}
}
close(out)
return result
}
func TestParserTokenizeDhcp(t *testing.T) {
test_1 := `
subnet 127.0.0.0 netmask 255.255.255.252 {
item 1234 5678;
tabbed item-1 1234;
quoted item-2 "hola mundo.";
}
`
expected := []string{
"subnet", "127.0.0.0", "netmask", "255.255.255.252", "{",
"item", "1234", "5678", ";",
"tabbed", "item-1", "1234", ";",
"quoted", "item-2", "\"hola mundo.\"", ";",
"}",
}
result := tokenizeDhcpConfigFromString(test_1)
t.Logf("testing for: %#v", expected)
t.Logf("checking out: %#v", result)
if len(result) != len(expected) {
t.Fatalf("length of token lists do not match (%d != %d)", len(result), len(expected))
}
for index := range expected {
if string(expected[index]) != string(result[index]) {
t.Errorf("unexpected token at index %d: %s != %s", index, expected[index], result[index])
}
}
}
func consumeTokens(tokes []string) chan string {
out := make(chan string)
go func() {
for _, item := range tokes {
out <- item
}
out <- ";"
close(out)
}()
return out
}
func TestParserDhcpParameters(t *testing.T) {
var ch chan string
test_1 := []string{"option", "whee", "whooo"}
ch = consumeTokens(test_1)
result := parseTokenParameter(ch)
if result.name != "option" {
t.Errorf("expected name %s, got %s", test_1[0], result.name)
}
if len(result.operand) == 2 {
if result.operand[0] != "whee" {
t.Errorf("expected operand[%d] as %s, got %s", 0, "whee", result.operand[0])
}
if result.operand[1] != "whooo" {
t.Errorf("expected operand[%d] as %s, got %s", 0, "whooo", result.operand[1])
}
} else {
t.Errorf("expected %d operands, got %d", 2, len(result.operand))
}
test_2 := []string{"whaaa", "whoaaa", ";", "wooops"}
ch = consumeTokens(test_2)
result = parseTokenParameter(ch)
if result.name != "whaaa" {
t.Errorf("expected name %s, got %s", test_2[0], result.name)
}
if len(result.operand) == 1 {
if result.operand[0] != "whoaaa" {
t.Errorf("expected operand[%d] as %s, got %s", 0, "whoaaa", result.operand[0])
}
} else {
t.Errorf("expected %d operands, got %d", 1, len(result.operand))
}
test_3 := []string{"optionz", "only", "{", "culled"}
ch = consumeTokens(test_3)
result = parseTokenParameter(ch)
if result.name != "optionz" {
t.Errorf("expected name %s, got %s", test_3[0], result.name)
}
if len(result.operand) == 1 {
if result.operand[0] != "only" {
t.Errorf("expected operand[%d] as %s, got %s", 0, "only", result.operand[0])
}
} else {
t.Errorf("expected %d operands, got %d", 1, len(result.operand))
}
}
func consumeTokensWithSignal(items []string) (chan string, sentinelSignaller) {
end := make(sentinelSignaller)
out := make(chan string)
inch := consumeTokens(items)
go func() {
for item := range inch {
out <- item
}
close(out)
close(end)
}()
return out, end
}
func consumeDhcpConfig(items []string) (tkGroup, error) {
out := make(chan string)
tch := consumeTokens(items)
end := make(sentinelSignaller)
go func() {
for item := range tch {
out <- item
}
close(end)
close(out)
}()
return parseDhcpConfig(end, out)
}
func compareSlice(a, b []string) bool {
if len(a) != len(b) {
return false
}
for i := range a {
if a[i] != b[i] {
return false
}
}
return true
}
func TestParserDhcpConfigParse(t *testing.T) {
test_1 := []string{
"allow", "unused-option", ";",
"lease-option", "1234", ";",
"more", "options", "hi", ";",
}
result_1, err := consumeDhcpConfig(test_1)
if err != nil {
t.Fatalf("%s", err)
}
if len(result_1.params) != 4 {
t.Fatalf("expected %d params, got %d", 3, len(result_1.params))
}
if result_1.params[0].name != "allow" {
t.Errorf("expected %s, got %s", "allow", result_1.params[0].name)
}
if !compareSlice(result_1.params[0].operand, []string{"unused-option"}) {
t.Errorf("unexpected options parsed: %v", result_1.params[0].operand)
}
if result_1.params[1].name != "lease-option" {
t.Errorf("expected %s, got %s", "lease-option", result_1.params[1].name)
}
if !compareSlice(result_1.params[1].operand, []string{"1234"}) {
t.Errorf("unexpected options parsed: %v", result_1.params[1].operand)
}
if result_1.params[2].name != "more" {
t.Errorf("expected %s, got %s", "lease-option", result_1.params[2].name)
}
if !compareSlice(result_1.params[2].operand, []string{"options", "hi"}) {
t.Errorf("unexpected options parsed: %v", result_1.params[2].operand)
}
test_2 := []string{
"first-option", ";",
"child", "group", "{",
"blah", ";",
"meh", ";",
"}",
"hidden", "option", "57005", ";",
"host", "device", "two", "{",
"skipped", "option", ";",
"more", "skipped", "options", ";",
"}",
"last", "option", "but", "unterminated",
}
result_2, err := consumeDhcpConfig(test_2)
if err != nil {
t.Fatalf("%s", err)
}
if len(result_2.groups) != 2 {
t.Fatalf("expected %d groups, got %d", 2, len(result_2.groups))
}
if len(result_2.params) != 3 {
t.Errorf("expected %d options, got %d", 3, len(result_2.params))
}
group0 := result_2.groups[0]
if group0.id.name != "child" {
t.Errorf("expected group %s, got %s", "child", group0.id.name)
}
if len(group0.id.operand) != 1 {
t.Errorf("expected group operand %d, got %d", 1, len(group0.params))
}
if len(group0.params) != 2 {
t.Errorf("expected group params %d, got %d", 2, len(group0.params))
}
group1 := result_2.groups[1]
if group1.id.name != "host" {
t.Errorf("expected group %s, got %s", "host", group1.id.name)
}
if len(group1.id.operand) != 2 {
t.Errorf("expected group operand %d, got %d", 2, len(group1.params))
}
if len(group1.params) != 2 {
t.Errorf("expected group params %d, got %d", 2, len(group1.params))
}
}
func TestParserReadDhcpConfig(t *testing.T) {
expected := []string{
`{global}
grants : map[unknown-clients:0]
parameters : map[default-lease-time:1800 max-lease-time:7200]
`,
`{subnet4 172.33.33.0/24},{global}
address : range4:172.33.33.128-172.33.33.254
options : map[broadcast-address:172.33.33.255 routers:172.33.33.2]
grants : map[unknown-clients:0]
parameters : map[default-lease-time:2400 max-lease-time:9600]
`,
`{host name:vmnet8},{global}
address : hardware-address:ethernet[00:50:56:c0:00:08],fixed-address4:172.33.33.1
options : map[domain-name:"packer.test"]
grants : map[unknown-clients:0]
parameters : map[default-lease-time:1800 max-lease-time:7200]
`,
}
f, err := os.Open(filepath.Join("testdata", "dhcpd-example.conf"))
if err != nil {
t.Fatalf("Unable to open dhcpd.conf sample: %s", err)
}
defer f.Close()
config, err := ReadDhcpConfiguration(f)
if err != nil {
t.Fatalf("Unable to read dhcpd.conf samplpe: %s", err)
}
if len(config) != 3 {
t.Fatalf("expected %d entries, got %d", 3, len(config))
}
for index, item := range config {
if item.repr() != expected[index] {
t.Errorf("Parsing of declaration %d did not match what was expected", index)
t.Logf("Result from parsing:\n%s", item.repr())
t.Logf("Expected to parse:\n%s", expected[index])
}
}
}

View File

@ -0,0 +1,20 @@
allow unknown-clients; # global.grants
default-lease-time 1800; # global.parameters
max-lease-time 7200; # global.parameters
subnet 172.33.33.0 netmask 255.255.255.0 { # subnet4
range 172.33.33.128 172.33.33.254; # subnet4.address
option broadcast-address 172.33.33.255; # subnet4.options
# allow unknown-clients; # subnet4.grants
default-lease-time 2400; # subnet4.parameters
max-lease-time 9600; # subnet4.parameters
option routers 172.33.33.2; # subnet4.options
}
host vmnet8 { # host
hardware ethernet 00:50:56:C0:00:08; # host.address
fixed-address 172.33.33.1; # host.address
option domain-name "packer.test"; # host.options
# allow unknown-clients; # subnet4.grants
# default-lease-time 1800; # subnet4.parameters
# max-lease-time 7200; # subnet4.parameters
}