GitHub #8: Seed indexes from index.yml

service/datastore/testable.go

Index: service/datastore/testable.go
diff --git a/service/datastore/testable.go b/service/datastore/testable.go
index 331156fbd4f7b33f74e3d9441b20a0b6488bdfac..2c8f28728633da9f3bc2c398a97af96453a89b1d 100644
--- a/service/datastore/testable.go
+++ b/service/datastore/testable.go
@@ -4,6 +4,8 @@
 
 package datastore
 
+import "io"

[iannucci, 2016/01/13 19:12:20]

always use

import (
  "io"
)

style. It's easier to add stuff later.

[nishanths (utexas), 2016/01/14 21:12:56]

Done.

+
 // TestingSnapshot is an opaque implementation-defined snapshot type.
 type TestingSnapshot interface {
 	ImATestingSnapshot()
@@ -73,4 +75,20 @@ type Testable interface {
 	// but never wants the in-memory versions of these entities to bleed through
 	// to the user code.
 	DisableSpecialEntities(bool)
+
+	// ParseIndexYAML parses the contents of a index YAML file into
+	// a list of datastore.IndexDefinitions.
+	//
+	// ParseIndexYAML panics if there was an error during parsing.
+	ParseIndexYAML(content io.Reader) []*IndexDefinition
+
+	// FindAndAddIndexYAML walks up from the directory of the source file
+	// until it finds a `index.yaml` or `index.yml` file.
+	// If an index YAML file is found, it opens and parses the file,
+	// and adds all the indexes found.
+	//
+	// FindAndAddIndexYAML panics if the root of the drive is reached without
+	// finding an index YAML file. FindAndAddIndexYAML also panics if there is
+	// an error reading the found index YAML file.
+	FindAndAddIndexYAML()

[dnj, 2016/01/13 16:16:40]

I don't think this capability needs to be added to the "Testable" interface.
Maybe top-level methods in "impl/memory"?

Also, both of these should return errors rather than panic on failure. They are
explicitly called by the user, so it's reasonable to task the user with handling
their failure.

[iannucci, 2016/01/13 19:12:20]

If anything they should be top level methods in service/datastore; there's
nothing impl/memory-specific about them.

To that end, moving them to be toplevel functions in this package:

  func ParseIndexYAML(io.Reader) ([]*IndexDefinition, error)
  func FindAndParseIndexYAML() ([]*IndexDefinition, error)

would be fine.
If they're in Testable, I disagree. 100% of the usecases would be to call them
and then assert no error. If they're top level functions and not testing
functions, then yes they should return errors.

[nishanths (utexas), 2016/01/14 21:12:56]

Done. Moved to service/datastore with the method signatures that @iannucci
posted.

 }