backdround/go-fstree

FSTree

FSTree is a module that works with filesystem trees driven by yaml.

It can:

• make new filetree that described by yaml
• check existing filetree by the given yaml description.

Installation

go get github.com/backdround/go-fstree/v2

Example make fstree

package main

import (
	"log"
	"strings"

	"github.com/backdround/go-fstree/v2"
)

var fstreeYaml =`
configs:
  config1.ini:
    type: file
    data: "port = 143"
  config2.yaml:
    type: file
    data: "port: 343"
pkg:
  pkg1:
    type: link
    path: ../../pkg1
`

func main() {
	fstreeYaml = strings.ReplaceAll(fstreeYaml, "\t", "  ")
	
	// Creates filesystem tree in ./project
	err := fstree.MakeOverOSFS("./project", fstreeYaml)
	
	if err != nil {
		log.Fatal(err)
	}
}

It creates the following structure:

project
├── configs
│   ├── config1.ini
│   └── config2.yaml
└── pkg
    └── pkg1 -> ../../pkg1

Example check fstree

package main

import (
	"log"
	"strings"

	"github.com/backdround/go-fstree/v2"
)

var fstreeYaml =`
configs:
  config1.ini:
    type: file
    data: "port = 143"
  config2.yaml:
    type: file
    data: "port: 343"
pkg:
  pkg1:
    type: link
    path: ../../pkg1
`

func main() {
	fstreeYaml = strings.ReplaceAll(fstreeYaml, "\t", "  ")
	
	// checks filesystem tree in ./project
	difference, err := fstree.CheckOverOSFS("./project", fstreeYaml)
	
	if err != nil {
		log.Fatal(err)
	}

	if difference != nil {
		log.Printf("Path %q isn't corresponds to the expected tree:\n",
			difference.Path)
		log.Println(difference.Real)
	} else {
		log.Println("./project is corresponds to the given yaml")
	}
}

It checks that ./project is corresponds to the following structure:

project
├── configs
│   ├── config1.ini
│   └── config2.yaml
└── pkg
    └── pkg1 -> ../../pkg1

Yaml entries

Directory

depth0:
  # No type field is setted
  depth1:
    # No type field is setted
    depth2:
      # No type field is setted

creates ROOTPATH/depth0/depth1/depath2 directory

File

file1.txt:
  # type is required
  type: file
  # data is optinal
  data: some file data

creates file ROOTPATH/file1.txt with data some file data

Link

link1:
  # type is reqired
  type: link
  # path is required
  path: ./some/destination

creates link ROOTPATH/link1 with destination ./some/destination