rename Table to SummaryTable

control/responsible_role.go

@@ -1,15 +1,16 @@
 package control
 
 import (
-	"github.com/jbowtie/gokogiri/xml"
 	"errors"
+	"fmt"
 	"regexp"
 	"strings"
-	"fmt"
+
+	"github.com/jbowtie/gokogiri/xml"
 )
 
 // findResponsibleRole looks for the Responsible Role cell in the control table.
-func findResponsibleRole(ct *Table) (*responsibleRole, error) {
+func findResponsibleRole(ct *SummaryTable) (*responsibleRole, error) {
 	nodes, err := ct.searchSubtree(".//w:tc[starts-with(normalize-space(.), 'Responsible Role')]")
 	if err != nil {
 		return nil, err
@@ -28,7 +29,7 @@ func findResponsibleRole(ct *Table) (*responsibleRole, error) {
 // responsibleRole is the container for the responsible role cell.
 type responsibleRole struct {
 	parentNode xml.Node
-	textNodes *[]xml.Node
+	textNodes  *[]xml.Node
 }
 
 // getContent returns the full string representation of the content of the cell itself.
@@ -73,4 +74,4 @@ func (r *responsibleRole) getValue() string {
 		}
 	}
 	return result
-}
+}

control/table.go → control/summary_table.go

@@ -15,12 +15,12 @@ const (
 	responsibleRoleField = "Responsible Role"
 )
 
-// Table represents the node in the Word docx XML tree that corresponds to a security control.
-type Table struct {
+// SummaryTable represents the node in the Word docx XML tree that corresponds to a security control.
+type SummaryTable struct {
 	Root xml.Node
 }
 
-func (ct *Table) searchSubtree(xpath string) (nodes []xml.Node, err error) {
+func (ct *SummaryTable) searchSubtree(xpath string) (nodes []xml.Node, err error) {
 	// http://stackoverflow.com/a/25387687/358804
 	if !strings.HasPrefix(xpath, ".") {
 		err = errors.New("XPath must have leading period (`.`) to only search the subtree")
@@ -30,7 +30,7 @@ func (ct *Table) searchSubtree(xpath string) (nodes []xml.Node, err error) {
 	return ct.Root.Search(xpath)
 }
 
-func (ct *Table) tableHeader() (content string, err error) {
+func (ct *SummaryTable) tableHeader() (content string, err error) {
 	nodes, err := ct.searchSubtree(".//w:tr")
 	if err != nil {
 		return
@@ -45,7 +45,7 @@ func (ct *Table) tableHeader() (content string, err error) {
 	return
 }
 
-func (ct *Table) controlName() (name string, err error) {
+func (ct *SummaryTable) controlName() (name string, err error) {
 	content, err := ct.tableHeader()
 	if err != nil {
 		return
@@ -61,7 +61,7 @@ func (ct *Table) controlName() (name string, err error) {
 }
 
 // Fill inserts the OpenControl justifications into the table. Note this modifies the `table`.
-func (ct *Table) Fill(openControlData opencontrols.Data) (err error) {
+func (ct *SummaryTable) Fill(openControlData opencontrols.Data) (err error) {
 	roleCell, err := findResponsibleRole(ct)
 	if err != nil {
 		return
@@ -79,7 +79,7 @@ func (ct *Table) Fill(openControlData opencontrols.Data) (err error) {
 }
 
 // diffResponsibleRole computes the diff of the responsible role cell.
-func (ct *Table) diffResponsibleRole(control string, openControlData opencontrols.Data) ([]reporter.Reporter, error) {
+func (ct *SummaryTable) diffResponsibleRole(control string, openControlData opencontrols.Data) ([]reporter.Reporter, error) {
 	roleCell, err := findResponsibleRole(ct)
 	if err != nil {
 		return []reporter.Reporter{}, err
@@ -95,10 +95,10 @@ func (ct *Table) diffResponsibleRole(control string, openControlData opencontrol
 }
 
 // Diff returns the list of diffs in the control table.
-func (ct *Table) Diff(openControlData opencontrols.Data) ([]reporter.Reporter, error) {
+func (ct *SummaryTable) Diff(openControlData opencontrols.Data) ([]reporter.Reporter, error) {
 	control, err := ct.controlName()
 	if err != nil {
 		return []reporter.Reporter{}, err
 	}
 	return ct.diffResponsibleRole(control, openControlData)
-}
+}

control/table_test.go → control/summary_table_test.go

@@ -36,6 +36,13 @@ func docFixture(control string) *xml.XmlDocument {
 	return doc
 }
 
+func getTable(control string) xml.Node {
+	doc := docFixture(control)
+	tables, err := doc.Search("//w:tbl")
+	Expect(err).NotTo(HaveOccurred())
+	return tables[0]
+}
+
 func openControlFixturePath() string {
 	path := filepath.Join("..", "fixtures", "opencontrols")
 	path, err := filepath.Abs(path)
@@ -56,27 +63,23 @@ func openControlFixture() opencontrols.Data {
 	return data
 }
 
-var _ = Describe("Table", func() {
+var _ = Describe("SummaryTable", func() {
 	Describe("Fill", func() {
 		It("fills in the Responsible Role for controls", func() {
-			doc := docFixture("AC-2")
-			tables, _ := doc.Search("//w:tbl")
-			table := tables[0]
-
-			ct := Table{Root: table}
+			table := getTable("AC-2")
+			ct := SummaryTable{Root: table}
 			openControlData := openControlFixture()
+
 			ct.Fill(openControlData)
 
 			Expect(table.Content()).To(ContainSubstring(`Responsible Role: Amazon Elastic Compute Cloud: AWS Staff`))
 		})
 
 		It("fills in the Responsible Role for control enhancements", func() {
-			doc := docFixture("AC-2 (1)")
-			tables, _ := doc.Search("//w:tbl")
-			table := tables[0]
-
-			ct := Table{Root: table}
+			table := getTable("AC-2 (1)")
+			ct := SummaryTable{Root: table}
 			openControlData := openControlFixture()
+
 			ct.Fill(openControlData)
 
 			Expect(table.Content()).To(ContainSubstring(`Responsible Role: Amazon Elastic Compute Cloud: AWS Staff`))
@@ -88,7 +91,7 @@ var _ = Describe("Table", func() {
 			tables, _ := doc.Search("//w:tbl")
 			table := tables[0]
 
-			ct := Table{Root: table}
+			ct := SummaryTable{Root: table}
 			openControlData := openControlFixture()
 			diff, err := ct.Diff(openControlData)
 

ssp/document_test.go

@@ -9,20 +9,37 @@ import (
 	. "github.com/onsi/gomega"
 )
 
+func loadSSP(name string) *Document {
+	path := filepath.Join("..", "fixtures", name)
+	doc, err := Load(path)
+	Expect(err).NotTo(HaveOccurred())
+	return doc
+}
+
 var _ = Describe("SSP", func() {
 	Describe("Load", func() {
 		It("gets the content from the doc", func() {
-			path := filepath.Join("..", "fixtures", "FedRAMP_ac-2-1_v2.1.docx")
-			s, err := Load(path)
-			Expect(err).NotTo(HaveOccurred())
-			defer s.Close()
+			doc := loadSSP("FedRAMP_ac-2-1_v2.1.docx")
+			defer doc.Close()
 
-			Expect(s.Content()).To(ContainSubstring("Control Enhancement"))
+			Expect(doc.Content()).To(ContainSubstring("Control Enhancement"))
 		})
 
 		It("give an error when the doc isn't found", func() {
 			_, err := Load("non-existent.docx")
 			Expect(err).To(HaveOccurred())
 		})
 	})
+
+	Describe("SummaryTables", func() {
+		It("returns the tables", func() {
+			doc := loadSSP("FedRAMP_ac-2_v2.1.docx")
+			defer doc.Close()
+
+			tables, err := doc.SummaryTables()
+
+			Expect(err).NotTo(HaveOccurred())
+			Expect(len(tables)).To(Equal(10))
+		})
+	})
 })

templater/templater.go

@@ -3,8 +3,8 @@ package templater
 import (
 	"github.com/opencontrol/fedramp-templater/control"
 	"github.com/opencontrol/fedramp-templater/opencontrols"
-	"github.com/opencontrol/fedramp-templater/ssp"
 	"github.com/opencontrol/fedramp-templater/reporter"
+	"github.com/opencontrol/fedramp-templater/ssp"
 )
 
 // TemplatizeSSP inserts OpenControl data into (i.e. modifies) the provided SSP.
@@ -14,7 +14,7 @@ func TemplatizeSSP(s *ssp.Document, openControlData opencontrols.Data) (err erro
 		return
 	}
 	for _, table := range tables {
-		ct := control.Table{Root: table}
+		ct := control.SummaryTable{Root: table}
 		err = ct.Fill(openControlData)
 		if err != nil {
 			return err
@@ -27,19 +27,19 @@ func TemplatizeSSP(s *ssp.Document, openControlData opencontrols.Data) (err erro
 }
 
 // DiffSSP will find the differences between data in the SSP and the OpenControl data.
-func DiffSSP(s *ssp.Document, openControlData opencontrols.Data) ([]reporter.Reporter, error){
+func DiffSSP(s *ssp.Document, openControlData opencontrols.Data) ([]reporter.Reporter, error) {
 	var diffInfo []reporter.Reporter
 	tables, err := s.SummaryTables()
 	if err != nil {
 		return diffInfo, err
 	}
 	for _, table := range tables {
-		ct := control.Table{Root: table}
+		ct := control.SummaryTable{Root: table}
 		tableDiffInfo, err := ct.Diff(openControlData)
 		if err != nil {
 			return diffInfo, err
 		}
 		diffInfo = append(diffInfo, tableDiffInfo...)
 	}
 	return diffInfo, nil
-}
+}