Define document nodes content with template #64

g-pavlov · 2020-10-25T16:01:24Z

What this PR does / why we need it:
Adds the third option for content assignment to document nodes - templates.
Contributes file system resource handler enabling local file system nodes in structures and git info for them.
With local file system support, template paths can be local file system paths too.

Which issue(s) this PR fixes:
Fixes #18
Completes #54

Release note:

Document nodes now support content assignment with Template.

Document nodes now support content assignment from local file system sources. NodeSelectors with local file path are supported but the optional filters of the selectors are not implemented yet.

Git info is supported for document nodes with local file system content assignment. The author/contributor details are limited to  what `git log` can offer - email and name. Requires `git` to be available and sufficient privileges for `docforge` to run `git log`.

swilen-iwanow · 2020-10-26T11:42:02Z

pkg/api/types.go

@@ -234,7 +234,7 @@ type Template struct {
 	// Sources maps variable names to ContentSelectors that will be
 	// used as specification for the content to fetch and assign ot that


used as specification for the content to fetch and assign to those variables

swilen-iwanow · 2020-10-26T12:01:35Z

pkg/reactor/document_worker.go

+					templateBlob []byte
+					tmpl         *template.Template
+				)
+				if tmpl, ok = w.templates[task.Node.Template.Path]; !ok {


could we have concurrent reads

swilen-iwanow · 2020-10-26T12:19:17Z

pkg/resourcehandlers/fs/fs.go

+
+// Accept implements resourcehandlers.ResourceHandler#Accept
+func (fs *fsHandler) Accept(uri string) bool {
+	if _, err := os.Stat(uri); err == nil {


we could just return err == nil

swilen-iwanow · 2020-10-26T12:25:12Z

pkg/resourcehandlers/fs/fs.go

+			if path != parentPath {
+				if len(strings.Split(path, "/"))-len(strings.Split(parentPath, "/")) != 1 {
+					node = node.Parent()
+					parentPathSegments := strings.Split(path, "/")


pathSegments intead of parentPathSegments

swilen-iwanow · 2020-10-26T12:27:23Z

pkg/resourcehandlers/fs/fs.go

+	return nil
+}
+
+func buildNodes(path string, info os.FileInfo) *api.Node {


is this used

swilen-iwanow · 2020-10-26T12:33:10Z

pkg/resourcehandlers/fs/fs.go

+	}
+
+	git := exec.Command("git", "log", "--date=short", `--pretty=format:'{%n  "sha": "%H",%n  "author": "%aN <%aE>",%n  "date": "%ad",%n  "message": "%s",%n  "email": "%aE",%n  "name": "%aN"%n },'`, "--follow", path)
+	if log, err = git.CombinedOutput(); err != nil {


I think if we use CombinedOutput here and the git command fails the stderr will be again saved to log. Is this desired?

g-pavlov · 2020-10-26T14:15:18Z

@swilen-iwanow ready for review after fixing requested changes

swilen-iwanow · 2020-10-26T15:43:38Z

lgtm

g-pavlov added area/documentation Documentation related kind/enhancement Enhancement, improvement, extension labels Oct 25, 2020

g-pavlov self-assigned this Oct 25, 2020

gardener-robot added kind/api-change API change with impact on API users needs/second-opinion Needs second review by someone else needs/review Needs review size/l Size of pull request is large (see gardener-robot robot/bots/size.py) labels Oct 25, 2020

gardener-robot-ci-3 added the reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) label Oct 25, 2020

gardener-robot-ci-2 added needs/ok-to-test Needs approval for testing (check PR in detail before setting this label because PR is run on CI/CD) and removed reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) labels Oct 25, 2020

g-pavlov force-pushed the template branch from 4dfda13 to 8295e93 Compare October 25, 2020 16:04

gardener-robot-ci-2 added the reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) label Oct 25, 2020

gardener-robot-ci-1 removed the reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) label Oct 25, 2020

g-pavlov force-pushed the template branch from 8295e93 to d650149 Compare October 25, 2020 16:22

gardener-robot-ci-1 added the reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) label Oct 25, 2020

gardener-robot-ci-3 removed the reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) label Oct 25, 2020

g-pavlov force-pushed the template branch from d650149 to c0b527c Compare October 25, 2020 17:49

gardener-robot-ci-2 added the reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) label Oct 25, 2020

gardener-robot-ci-3 removed the reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) label Oct 25, 2020

g-pavlov force-pushed the template branch from c0b527c to c14fcbf Compare October 25, 2020 17:54

gardener-robot-ci-2 added the reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) label Oct 25, 2020

g-pavlov force-pushed the template branch from c14fcbf to aa28677 Compare October 25, 2020 17:55

gardener-robot-ci-3 removed the reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) label Oct 25, 2020

gardener-robot-ci-2 added reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) and removed reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) labels Oct 25, 2020

g-pavlov requested a review from swilen-iwanow October 26, 2020 08:26

g-pavlov force-pushed the master branch from 021bb6f to a0b327d Compare October 26, 2020 11:06

swilen-iwanow suggested changes Oct 26, 2020

View reviewed changes

gardener-robot added needs/changes Needs (more) changes and removed needs/review Needs review labels Oct 26, 2020

document node content by template

6f94d12

g-pavlov force-pushed the template branch from aa28677 to 26c329c Compare October 26, 2020 14:07

gardener-robot-ci-1 added reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) and removed reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) labels Oct 26, 2020

g-pavlov added needs/review Needs review and removed needs/second-opinion Needs second review by someone else labels Oct 26, 2020

gardener-robot removed the needs/review Needs review label Oct 26, 2020

g-pavlov force-pushed the template branch from 26c329c to 0d8aa36 Compare October 26, 2020 14:23

gardener-robot added the needs/second-opinion Needs second review by someone else label Oct 26, 2020

gardener-robot-ci-2 added reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) and removed reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) labels Oct 26, 2020

simple file system resource handler

77232da

g-pavlov force-pushed the template branch from 0d8aa36 to 77232da Compare October 26, 2020 15:25

gardener-robot-ci-3 added the reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) label Oct 26, 2020

gardener-robot-ci-1 removed the reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) label Oct 26, 2020

swilen-iwanow merged commit 100dd66 into master Oct 26, 2020

g-pavlov deleted the template branch October 26, 2020 16:34

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Define document nodes content with template #64

Define document nodes content with template #64

g-pavlov commented Oct 25, 2020 •

edited

Loading

swilen-iwanow Oct 26, 2020

swilen-iwanow Oct 26, 2020

swilen-iwanow Oct 26, 2020

swilen-iwanow Oct 26, 2020

swilen-iwanow Oct 26, 2020

swilen-iwanow Oct 26, 2020

g-pavlov commented Oct 26, 2020

swilen-iwanow commented Oct 26, 2020

		@@ -234,7 +234,7 @@ type Template struct {
		// Sources maps variable names to ContentSelectors that will be
		// used as specification for the content to fetch and assign ot that

Define document nodes content with template #64

Define document nodes content with template #64

Conversation

g-pavlov commented Oct 25, 2020 • edited Loading

swilen-iwanow Oct 26, 2020

Choose a reason for hiding this comment

swilen-iwanow Oct 26, 2020

Choose a reason for hiding this comment

swilen-iwanow Oct 26, 2020

Choose a reason for hiding this comment

swilen-iwanow Oct 26, 2020

Choose a reason for hiding this comment

swilen-iwanow Oct 26, 2020

Choose a reason for hiding this comment

swilen-iwanow Oct 26, 2020

Choose a reason for hiding this comment

g-pavlov commented Oct 26, 2020

swilen-iwanow commented Oct 26, 2020

g-pavlov commented Oct 25, 2020 •

edited

Loading