Merge pull request #27 from compspec/wip-for-rainbow-register

wip: integration with rainbow

Author: vsoch

cmd/compspec/create/artifact.go

@@ -1,31 +1,31 @@
 package create
 
 import (
-"strings"
-
+"github.com/compspec/compspec-go/pkg/plugin"
 "github.com/compspec/compspec-go/plugins/creators/artifact"
 )
 
 // Artifact will create a compatibility artifact based on a request in YAML
 // TODO likely want to refactor this into a proper create plugin
 func Artifact(specname string, fields []string, saveto string, allowFail bool) error {
 
-// This is janky, oh well
-allowFailFlag := "false"
-if allowFail {
-allowFailFlag = "true"
-}
-
 // assemble options for node creator
 creator, err := artifact.NewPlugin()
 if err != nil {
 return err
 }
-options := map[string]string{
-"specname": specname,
-"fields": strings.Join(fields, "||"),
-"saveto": saveto,
-"allowFail": allowFailFlag,
+
+options := plugin.PluginOptions{
+StrOpts: map[string]string{
+"specname": specname,
+"saveto": saveto,
+},
+BoolOpts: map[string]bool{
+"allowFail": allowFail,
+},
+ListOpts: map[string][]string{
+"fields": fields,
+},
 }
 return creator.Create(options)
 }

cmd/compspec/create/nodes.go

@@ -1,6 +1,7 @@
 package create
 
 import (
+"github.com/compspec/compspec-go/pkg/plugin"
 "github.com/compspec/compspec-go/plugins/creators/cluster"
 )
 
@@ -14,10 +15,12 @@ func Nodes(nodesDir, clusterName, nodeOutFile string) error {
 if err != nil {
 return err
 }
-options := map[string]string{
-"nodes-dir": nodesDir,
-"cluster-name": clusterName,
-"node-outfile": nodeOutFile,
+options := plugin.PluginOptions{
+StrOpts: map[string]string{
+"nodes-dir": nodesDir,
+"cluster-name": clusterName,
+"node-outfile": nodeOutFile,
+},
 }
 return creator.Create(options)
 }

docs/rainbow/README.md

@@ -44,5 +44,5 @@ compspec extract --name library --name nfd[cpu,memory,network,storage,system] --
 Now we are going to give compspec the directory, and ask it to create nodes. This will be in JSON graph format. This outputs to the terminal:
 
 ```bash
-compspec create nodes --cluster-name cluster-red --node-dir ./docs/rainbow/cluster/
+compspec create nodes --cluster-name cluster-red --node-dir ./docs/rainbow/cluster/ --nodes-output ./cluster-nodes.json
 ```

pkg/graph/cluster.go

@@ -4,6 +4,7 @@ import (
 "encoding/json"
 "fmt"
 "os"
+"strings"
 
 "github.com/compspec/compspec-go/pkg/utils"
 "github.com/converged-computing/jsongraph-go/jsongraph/metadata"
@@ -20,6 +21,9 @@ type ClusterGraph struct {
 // Top level counter for node labels (JGF v2) that maps to ids (JGF v1)
 nodeCounter int32
 
+// Easy reference to root name
+rootName string
+
 // Counters for specific resource types (e.g., rack, node)
 resourceCounters map[string]int32
 }
@@ -41,7 +45,7 @@ func (c *ClusterGraph) SaveGraph(path string) error {
 fmt.Printf("Graph %s already exists, will not overwrite\n", path)
 return nil
 }
-content, err := json.MarshalIndent(c.Graph, "", " ")
+content, err := json.MarshalIndent(c, "", " ")
 if err != nil {
 return err
 }
@@ -55,10 +59,15 @@ func (c *ClusterGraph) SaveGraph(path string) error {
 
 // Path gets a new path
 func getNodePath(root, subpath string) string {
+var path string
 if subpath == "" {
-return fmt.Sprintf("/%s", root)
+path = fmt.Sprintf("/%s", root)
+} else {
+path = fmt.Sprintf("/%s/%s", root, subpath)
 }
-return fmt.Sprintf("/%s/%s", root, subpath)
+// Hack to allow for imperfection of slash placement
+path = strings.ReplaceAll(path, "//", "/")
+return path
 }
 
 // AddNode adds a node to the graph
@@ -69,8 +78,9 @@ func (c *ClusterGraph) AddNode(
 size int32,
 exclusive bool,
 unit string,
+path string,
 ) *graph.Node {
-node := c.getNode(resource, name, size, exclusive, unit)
+node := c.getNode(resource, name, size, exclusive, unit, path)
 c.Graph.Nodes[*node.Label] = *node
 return node
 }
@@ -88,6 +98,7 @@ func (c *ClusterGraph) getNode(
 size int32,
 exclusive bool,
 unit string,
+path string,
 ) *graph.Node {
 
 // Get the identifier for the resource type
@@ -101,24 +112,26 @@ func (c *ClusterGraph) getNode(
 
 // The id in the metadata is the counter for that resource type
 resourceCounter := fmt.Sprintf("%d", counter)
+nameWithCount := fmt.Sprintf("%s%d", name, counter)
 
 // The resource name is the type + the resource counter
-resourceName := fmt.Sprintf("%s%d", name, counter)
+// path should be assembled from parents up to this node
+resourceName := fmt.Sprintf("%s/%s%d", path, name, counter)
 
 // New Metadata with expected fluxion data
 m := metadata.Metadata{}
 m.AddElement("type", resource)
 m.AddElement("basename", name)
 m.AddElement("id", resourceCounter)
-m.AddElement("name", resourceName)
+m.AddElement("name", nameWithCount)
 
 // uniq_id should be the same as the label, but as an integer
 m.AddElement("uniq_id", count)
 m.AddElement("rank", -1)
 m.AddElement("exclusive", exclusive)
 m.AddElement("unit", unit)
 m.AddElement("size", size)
-m.AddElement("paths", map[string]string{"containment": getNodePath(name, "")})
+m.AddElement("paths", map[string]string{"containment": getNodePath(c.rootName, resourceName)})
 
 // Update the resource counter
 counter += 1
@@ -154,7 +167,7 @@ func NewClusterGraph(name string) (ClusterGraph, error) {
 m.AddElement("exclusive", false)
 m.AddElement("unit", "")
 m.AddElement("size", 1)
-m.AddElement("paths", map[string]string{"containment": getNodePath(name, "")})
+m.AddElement("paths", map[string]string{"containment": getNodePath(clusterName, "")})
 
 // Root cluster node
 label := "0"
@@ -166,7 +179,7 @@ func NewClusterGraph(name string) (ClusterGraph, error) {
 // Create a new cluster!
 // Start counting at 1 - index 0 is the cluster root
 resourceCounters := map[string]int32{"cluster": int32(1)}
-cluster := ClusterGraph{g, name, 1, resourceCounters}
+cluster := ClusterGraph{g, name, 1, clusterName, resourceCounters}
 
 return cluster, nil
 }

pkg/plugin/plugin.go

@@ -24,7 +24,16 @@ type PluginInterface interface {
 Sections() []string
 
 // Creators take a map of named options
-Create(map[string]string) error
+Create(PluginOptions) error
+}
+
+// PluginOptions allow packaging named values of different types
+// This is an alternative to using interfaces.
+type PluginOptions struct {
+BoolOpts map[string]bool
+StrOpts map[string]string
+IntOpts map[string]int32
+ListOpts map[string][]string
 }
 
 // ExtractorData is returned by an extractor

plugins/creators/artifact/artifact.go

@@ -3,7 +3,6 @@ package artifact
 import (
 "fmt"
 "os"
-"strings"
 
 "github.com/compspec/compspec-go/pkg/plugin"
 "github.com/compspec/compspec-go/pkg/types"
@@ -37,21 +36,16 @@ func (c ArtifactCreator) IsCreator() bool { return true }
 func (c ArtifactCreator) IsExtractor() bool { return false }
 
 // Create generates the desired output
-func (c ArtifactCreator) Create(options map[string]string) error {
+func (c ArtifactCreator) Create(options plugin.PluginOptions) error {
 
 // unwrap options (we can be sure they are at least provided)
-specname := options["specname"]
-saveto := options["saveto"]
-fieldsCombined := options["fields"]
-fields := strings.Split(fieldsCombined, "||")
+specname := options.StrOpts["specname"]
+saveto := options.StrOpts["saveto"]
+fields := options.ListOpts["fields"]
 
 // This is uber janky. We could use interfaces
 // But I just feel so lazy right now
-allowFailFlag := options["allowFail"]
-allowFail := false
-if allowFailFlag == "true" {
-allowFail = true
-}
+allowFail := options.BoolOpts["allowFail"]
 
 // Cut out early if a spec not provided
 if specname == "" {

plugins/creators/cluster/cluster.go

@@ -38,12 +38,12 @@ func (c ClusterCreator) IsCreator() bool { return true }
 func (c ClusterCreator) IsExtractor() bool { return false }
 
 // Create generates the desired output
-func (c ClusterCreator) Create(options map[string]string) error {
+func (c ClusterCreator) Create(options plugin.PluginOptions) error {
 
 // unwrap options (we can be sure they are at least provided)
-nodesDir := options["nodes-dir"]
-clusterName := options["cluster-name"]
-nodeOutFile := options["node-outfile"]
+nodesDir := options.StrOpts["nodes-dir"]
+clusterName := options.StrOpts["cluster-name"]
+nodeOutFile := options.StrOpts["node-outfile"]
 
 // Read in each node into a plugins.Result
 //	Results map[string]plugin.PluginData `json:"extractors,omitempty"`
@@ -92,7 +92,8 @@ func (c ClusterCreator) Create(options map[string]string) error {
 // size (usually 1)
 // exclusive (usually false)
 // unit (usually empty or an amount)
-rack := *g.AddNode("rack", "rack", 1, false, "")
+// path (root and current resource path are added, so empty here)
+rack := *g.AddNode("rack", "rack", 1, false, "", "")
 
 // Connect the rack to the parent, both ways.
 // I think this is because fluxion is Depth First and Upwards (dfu)
@@ -145,7 +146,8 @@ func (c ClusterCreator) Create(options map[string]string) error {
 }
 
 // First add the rack -> node
-node := *g.AddNode("node", "node", 1, false, "")
+// We only have one rack here, so hard coded id for now
+node := *g.AddNode("node", "node", 1, false, "", "rack0")
 g.AddEdge(rack, node, "contains")
 g.AddEdge(node, rack, "in")
 
@@ -171,21 +173,23 @@ func (c ClusterCreator) Create(options map[string]string) error {
 // TODO we should also get this in better detail, physical vs logical cores
 items := []string{}
 for i := 0; i < cpuCount; i++ {
-items = append(items, fmt.Sprintf("%s", i))
+items = append(items, fmt.Sprintf("%d", i))
 }
 // Mapping of socket to cores
 chunks := utils.Chunkify(items, socketCount)
 for _, chunk := range chunks {
 
 // Create each socket attached to the node
 // rack -> node -> socket
-socketNode := *g.AddNode("socket", "socket", 1, false, "")
+path := fmt.Sprintf("rack0/node%s", *node.Label)
+socketNode := *g.AddNode("socket", "socket", 1, false, "", path)
 g.AddEdge(node, socketNode, "contains")
 g.AddEdge(socketNode, node, "in")
 
 // Create each core attached to the socket
 for _, _ = range chunk {
-coreNode := *g.AddNode("core", "core", 1, false, "")
+path := fmt.Sprintf("rack0/node%s/socket%s", *node.Label, *socketNode.Label)
+coreNode := *g.AddNode("core", "core", 1, false, "", path)
 g.AddEdge(socketNode, coreNode, "contains")
 g.AddEdge(coreNode, socketNode, "in")
 

plugins/extractors/kernel/kernel.go

@@ -27,11 +27,9 @@ func (e KernelExtractor) Description() string {
 return ExtractorDescription
 }
 
-func (e KernelExtractor) Create(options map[string]string) error {
-return nil
-}
-func (e KernelExtractor) IsCreator() bool { return false }
-func (e KernelExtractor) IsExtractor() bool { return true }
+func (e KernelExtractor) Create(plugin.PluginOptions) error { return nil }
+func (e KernelExtractor) IsCreator() bool { return false }
+func (e KernelExtractor) IsExtractor() bool { return true }
 
 func (e KernelExtractor) Sections() []string {
 return e.sections

plugins/extractors/library/library.go

@@ -33,12 +33,9 @@ func (e LibraryExtractor) Description() string {
 return ExtractorDescription
 }
 
-func (e LibraryExtractor) Create(options map[string]string) error {
-return nil
-}
-
-func (e LibraryExtractor) IsCreator() bool { return false }
-func (e LibraryExtractor) IsExtractor() bool { return true }
+func (e LibraryExtractor) Create(plugin.PluginOptions) error { return nil }
+func (e LibraryExtractor) IsCreator() bool { return false }
+func (e LibraryExtractor) IsExtractor() bool { return true }
 
 // Validate ensures that the sections provided are in the list we know
 func (e LibraryExtractor) Validate() bool {

plugins/extractors/nfd/nfd.go

@@ -69,12 +69,9 @@ func (e NFDExtractor) Description() string {
 return ExtractorDescription
 }
 
-func (e NFDExtractor) Create(options map[string]string) error {
-return nil
-}
-
-func (e NFDExtractor) IsCreator() bool { return false }
-func (e NFDExtractor) IsExtractor() bool { return true }
+func (e NFDExtractor) Create(plugin.PluginOptions) error { return nil }
+func (e NFDExtractor) IsCreator() bool { return false }
+func (e NFDExtractor) IsExtractor() bool { return true }
 
 // Validate ensures that the sections provided are in the list we know
 func (e NFDExtractor) Validate() bool {