mirror of
https://github.com/strongdm/comply
synced 2024-07-17 00:00:37 +00:00
49e950c3c0
The pandoc version must be 2.2.1 or greater. Defaults can be overridden by an optional "pandoc: pandoc" or "pandoc: docker" in the comply.yml.
125 lines
2.9 KiB
Go
125 lines
2.9 KiB
Go
package render
|
|
|
|
import (
|
|
"bytes"
|
|
"fmt"
|
|
"io/ioutil"
|
|
"os"
|
|
"path/filepath"
|
|
"strings"
|
|
"sync"
|
|
"text/template"
|
|
"time"
|
|
|
|
"github.com/pkg/errors"
|
|
"github.com/strongdm/comply/internal/config"
|
|
"github.com/strongdm/comply/internal/model"
|
|
)
|
|
|
|
// TODO: refactor and eliminate duplication among narrative, policy renderers
|
|
func renderNarrativeToDisk(wg *sync.WaitGroup, errOutputCh chan error, data *renderData, narrative *model.Narrative, live bool) {
|
|
// only files that have been touched
|
|
if !isNewer(narrative.FullPath, narrative.ModifiedAt) {
|
|
return
|
|
}
|
|
recordModified(narrative.FullPath, narrative.ModifiedAt)
|
|
|
|
wg.Add(1)
|
|
go func(p *model.Narrative) {
|
|
defer wg.Done()
|
|
|
|
outputFilename := p.OutputFilename
|
|
// save preprocessed markdown
|
|
err := preprocessNarrative(data, p, filepath.Join(".", "output", outputFilename+".md"))
|
|
if err != nil {
|
|
errOutputCh <- errors.Wrap(err, "unable to preprocess")
|
|
return
|
|
}
|
|
|
|
pandoc(outputFilename, errOutputCh)
|
|
|
|
// remove preprocessed markdown
|
|
err = os.Remove(filepath.Join(".", "output", outputFilename+".md"))
|
|
if err != nil {
|
|
errOutputCh <- err
|
|
return
|
|
}
|
|
|
|
rel, err := filepath.Rel(config.ProjectRoot(), p.FullPath)
|
|
if err != nil {
|
|
rel = p.FullPath
|
|
}
|
|
fmt.Printf("%s -> %s\n", rel, filepath.Join("output", p.OutputFilename))
|
|
|
|
}(narrative)
|
|
}
|
|
|
|
func preprocessNarrative(data *renderData, pol *model.Narrative, fullPath string) error {
|
|
cfg := config.Config()
|
|
|
|
var w bytes.Buffer
|
|
bodyTemplate, err := template.New("body").Parse(pol.Body)
|
|
if err != nil {
|
|
w.WriteString(fmt.Sprintf("# Error processing template:\n\n%s\n", err.Error()))
|
|
} else {
|
|
bodyTemplate.Execute(&w, data)
|
|
}
|
|
body := w.String()
|
|
|
|
revisionTable := ""
|
|
satisfiesTable := ""
|
|
|
|
// ||Date|Comment|
|
|
// |---+------|
|
|
// | 4 Jan 2018 | Initial Version |
|
|
// Table: Document history
|
|
|
|
if len(pol.Satisfies) > 0 {
|
|
rows := ""
|
|
for standard, keys := range pol.Satisfies {
|
|
rows += fmt.Sprintf("| %s | %s |\n", standard, strings.Join(keys, ", "))
|
|
}
|
|
satisfiesTable = fmt.Sprintf("|Standard|Controls Satisfied|\n|-------+--------------------------------------------|\n%s\nTable: Control satisfaction\n", rows)
|
|
}
|
|
|
|
if len(pol.Revisions) > 0 {
|
|
rows := ""
|
|
for _, rev := range pol.Revisions {
|
|
rows += fmt.Sprintf("| %s | %s |\n", rev.Date, rev.Comment)
|
|
}
|
|
revisionTable = fmt.Sprintf("|Date|Comment|\n|---+--------------------------------------------|\n%s\nTable: Document history\n", rows)
|
|
}
|
|
|
|
doc := fmt.Sprintf(`%% %s
|
|
%% %s
|
|
%% %s
|
|
|
|
---
|
|
header-includes: yes
|
|
head-content: "%s"
|
|
foot-content: "%s confidential %d"
|
|
---
|
|
|
|
%s
|
|
|
|
%s
|
|
|
|
\newpage
|
|
%s`,
|
|
pol.Name,
|
|
cfg.Name,
|
|
fmt.Sprintf("%s %d", pol.ModifiedAt.Month().String(), pol.ModifiedAt.Year()),
|
|
pol.Name,
|
|
cfg.Name,
|
|
time.Now().Year(),
|
|
satisfiesTable,
|
|
revisionTable,
|
|
body,
|
|
)
|
|
err = ioutil.WriteFile(fullPath, []byte(doc), os.FileMode(0644))
|
|
if err != nil {
|
|
return errors.Wrap(err, "unable to write preprocessed narrative to disk")
|
|
}
|
|
return nil
|
|
}
|