-
Notifications
You must be signed in to change notification settings - Fork 247
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Internal: Replaced hardcoded UUIDs with randomly generated UUIDs #560
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -20,6 +20,7 @@ import ( | |
"io/ioutil" | ||
"os" | ||
"path/filepath" | ||
"regexp" | ||
"strings" | ||
"testing" | ||
"time" | ||
|
@@ -30,6 +31,9 @@ import ( | |
|
||
// Register the tests | ||
_ "github.com/coreos/ignition/tests/registry" | ||
|
||
// UUID generation tool | ||
"github.com/pborman/uuid" | ||
) | ||
|
||
var ( | ||
|
@@ -76,6 +80,9 @@ func TestIgnitionBlackBoxNegative(t *testing.T) { | |
func outer(t *testing.T, test types.Test, negativeTests bool) error { | ||
t.Log(test.Name) | ||
|
||
// Maps $uuid<num> such that two variables with the same <num> have identical UUID | ||
UUIDmap := make(map[string]string) | ||
|
||
ctx, cancelFunc := context.WithDeadline(context.Background(), time.Now().Add(testTimeout)) | ||
defer cancelFunc() | ||
|
||
|
@@ -123,7 +130,7 @@ func outer(t *testing.T, test types.Test, negativeTests bool) error { | |
// Finish data setup | ||
for _, part := range disk.Partitions { | ||
if part.GUID == "" { | ||
part.GUID, err = generateUUID(t, ctx) | ||
part.GUID = uuid.New() | ||
if err != nil { | ||
return err | ||
} | ||
|
@@ -143,6 +150,46 @@ func outer(t *testing.T, test types.Test, negativeTests bool) error { | |
} | ||
test.Out[i].SetOffsets() | ||
|
||
// Replace all UUID variables (format $uuid<num>) in configs and partitions with an UUID | ||
test.Config, err = replaceUUIDVars(t, test.Config, UUIDmap) | ||
if err != nil { | ||
return err | ||
} | ||
|
||
for _, disk := range test.In { | ||
for _, partition := range disk.Partitions { | ||
partition.TypeGUID, err = replaceUUIDVars(t, partition.TypeGUID, UUIDmap) | ||
if err != nil { | ||
return err | ||
} | ||
partition.GUID, err = replaceUUIDVars(t, partition.GUID, UUIDmap) | ||
if err != nil { | ||
return err | ||
} | ||
partition.FilesystemUUID, err = replaceUUIDVars(t, partition.FilesystemUUID, UUIDmap) | ||
if err != nil { | ||
return err | ||
} | ||
} | ||
} | ||
|
||
for _, disk := range test.Out { | ||
for _, partition := range disk.Partitions { | ||
partition.TypeGUID, err = replaceUUIDVars(t, partition.TypeGUID, UUIDmap) | ||
if err != nil { | ||
return err | ||
} | ||
partition.GUID, err = replaceUUIDVars(t, partition.GUID, UUIDmap) | ||
if err != nil { | ||
return err | ||
} | ||
partition.FilesystemUUID, err = replaceUUIDVars(t, partition.FilesystemUUID, UUIDmap) | ||
if err != nil { | ||
return err | ||
} | ||
} | ||
} | ||
|
||
// Creation | ||
err = createVolume(t, ctx, tmpDirectory, i, disk.ImageFile, imageSize, disk.Partitions) | ||
// Move value into the local scope, because disk.ImageFile will change | ||
|
@@ -311,3 +358,28 @@ func outer(t *testing.T, test types.Test, negativeTests bool) error { | |
} | ||
return nil | ||
} | ||
|
||
// Identify and replace $uuid<num> with correct UUID | ||
// Variables with matching <num> should have identical UUIDs | ||
func replaceUUIDVars(t *testing.T, str string, UUIDmap map[string]string) (string, error) { | ||
finalStr := str | ||
|
||
pattern := regexp.MustCompile("\\$uuid([0-9]+)") | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We technically don't need to have a separate capture group for the digits anymore as we're not directly matching them. This could be shortened to There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. eh, I'm fine with it. doesn't much matter either way. |
||
for _, match := range pattern.FindAllStringSubmatch(str, -1) { | ||
if len(match) != 2 { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I don't think this check is necessary. The regex only has 2 capture groups (both of which must be present for it to be returned by There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'd prefer to have it. Doesn't hurt and might prevent us from shooting outselves in the foot later on. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Fair enough, this one I mostly brought up as if we end up switching the There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. meh, error handling is fine. |
||
return str, fmt.Errorf("find all string submatch error: want length of 2, got length of %d", len(match)) | ||
} | ||
|
||
finalStr = strings.Replace(finalStr, match[0], getUUID(match[0], UUIDmap), 1) | ||
} | ||
return finalStr, nil | ||
} | ||
|
||
// Format: $uuid<num> where the uuid variable (uuid<num>) is the key | ||
// value is the UUID for this uuid variable | ||
func getUUID(key string, UUIDmap map[string]string) string { | ||
if _, ok := UUIDmap[key]; !ok { | ||
UUIDmap[key] = uuid.New() | ||
} | ||
return UUIDmap[key] | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why are we running replace against
TypeGUID
?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why not? As far as Ignition is concerned its just another thing that can match or not match.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
My understanding of the original driving force that led to this PR was that we wanted to eliminate duplicate UUIDs in fields where having non-unique entries across multiple tests could lead to parallelism issues.
I'm not particularly against doing this but I don't think it really provides much if any value to do so.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's also to allow you to say "parition N should look like this, fix it if it doesnt" and type guids are just as much a part of that. Ignoring what this might be used for, its still a code path in Ignition that should get testing.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The code path is still being tested regardless of if the UUID is generated or not.
I will concede that it doesn't particularly matter what the
TypeGUID
is in most cases though and for ease of writing having the functionality applied makes sense.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh, yeah it doesn't really matter. The $uuidN is just much easier to read/write. If we really wanted to mock out real world use cases we could include all of the special type guid (e.g. coreos root on raid) in the templating function.