feat: added project level configurable license

Author: mahendraintelops

cmd/generate.go

@@ -9,6 +9,7 @@ import (
 	log "github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
 	"os"
+	"path/filepath"
 )
 
 // generateCmd represents the generate command
@@ -61,6 +62,23 @@ func GenerateCode() error {
 		return err
 	}
 
+	// assign absolute path to the license file Path if it's not
+	absPath, err := filepath.Abs(coreProject.License.Path)
+	if err != nil {
+		log.Errorf("error while getting absolute path [" + err.Error() + "]")
+		return err
+	}
+	coreProject.License.Path = absPath
+	// assign absolute path to the license file path if it's not (if supplied for the nodes)
+	for _, node := range coreProject.CompageJSON.Nodes {
+		absPath, err = filepath.Abs(node.License.Path)
+		if err != nil {
+			log.Errorf("error while getting absolute path [" + err.Error() + "]")
+			return err
+		}
+		node.License.Path = absPath
+	}
+
 	// pull all required templates
 	// pull the common templates
 	err = ociregistry.PullOCIArtifact("common", project.Version)

cmd/models/config.go

@@ -22,9 +22,16 @@ type GitDetails struct {
 	Platform   Platform   `yaml:"platform,omitempty"`
 }
 
+type License struct {
+	Name string `yaml:"name,omitempty"`
+	URL  string `yaml:"url,omitempty"`
+	Path string `yaml:"path,omitempty"`
+}
+
 type Project struct {
 	Name            string                 `yaml:"name"`
 	Version         string                 `yaml:"version"`
+	License         License                `yaml:"license"`
 	GitDetails      GitDetails             `yaml:"git"`
 	CompageJSON     map[string]interface{} `yaml:"compageJSON"`
 	ProjectMetadata string                 `yaml:"projectMetadata"`

internal/converter/cmd/converter.go

@@ -21,6 +21,7 @@ func GetProject(input *models.Project) (*core.Project, error) {
 		CompageJSON:         compageJSON,
 		Name:                input.Name,
 		Version:             input.Version,
+		License:             &input.License,
 		GitPlatformName:     input.GitDetails.Platform.Name,
 		GitPlatformURL:      input.GitDetails.Platform.URL,
 		GitPlatformUserName: input.GitDetails.Platform.UserName,

internal/core/models.go

@@ -1,6 +1,7 @@
 package core
 
 import (
+	"github.com/intelops/compage/cmd/models"
 	coreedge "github.com/intelops/compage/internal/core/edge"
 	corenode "github.com/intelops/compage/internal/core/node"
 	"time"
@@ -19,6 +20,7 @@ type ModificationDetails struct {
 type Project struct {
 	Name                string                 `json:"name"`
 	Version             string                 `json:"version"`
+	License             *models.License        `json:"license"`
 	CompageJSON         *CompageJSON           `json:"compageJSON"`
 	GitRepositoryName   string                 `json:"gitRepositoryName"`
 	GitRepositoryURL    string                 `json:"gitRepositoryURL"`

internal/core/node/node.go

@@ -7,6 +7,8 @@ type Node struct {
 	Language string `json:"language"`
 	// Name of a component (required, this will be service and deployment name).
 	Name string `json:"name"`
+	// License of the component.
+	License *License `json:"license"`
 	// RestConfig holds all config related to REST. If nil, it means that the node is not REST server or has REST clients.
 	RestConfig *RestConfig `json:"restConfig,omitempty"`
 	// GrpcConfig holds all config related to gRPC. If nil, it means that the node is not gRPC server or has gRPC clients.
@@ -19,6 +21,12 @@ type Node struct {
 	Annotations map[string]string `json:"annotations,omitempty"`
 }
 
+type License struct {
+	Name string `yaml:"name,omitempty"`
+	URL  string `yaml:"url,omitempty"`
+	Path string `yaml:"path,omitempty"`
+}
+
 type RestServer struct {
 	Port      string      `json:"port"`
 	SQLDB     string      `json:"sqlDB"`

internal/integrations/license/copier.go

@@ -1,6 +1,7 @@
 package license
 
 import (
+	"github.com/intelops/compage/cmd/models"
 	"github.com/intelops/compage/internal/core"
 	"github.com/intelops/compage/internal/languages/executor"
 	"github.com/intelops/compage/internal/utils"
@@ -14,6 +15,7 @@ type Copier struct {
 	ProjectDirectoryName string
 	GitRepositoryName    string
 	TemplatesRootPath    string
+	License              *models.License
 	Data                 map[string]interface{}
 }
 
@@ -37,6 +39,7 @@ func NewCopier(project *core.Project) (*Copier, error) {
 		ProjectDirectoryName: utils.GetProjectDirectoryName(project.Name),
 		GitRepositoryName:    project.GitRepositoryName,
 		Data:                 data,
+		License:              project.License,
 	}, nil
 }
 
@@ -47,7 +50,22 @@ func (c Copier) CreateLicenseFiles() error {
 		log.Errorf("error while creating directories [" + err.Error() + "]")
 		return err
 	}
-
+	// copy license file if it's been supplied
+	if c.License != nil && len(c.License.URL) > 0 {
+		// read file from url in c.License.URL. This is applicable for both config.yaml file and ui flow.
+		return utils.DownloadFile(c.ProjectDirectoryName+"/LICENCE", c.License.URL)
+	} else if c.License != nil && len(c.License.Path) > 0 {
+		// local license file sent via config.yaml file.
+		// get the absolute path of the license file
+		_, err := utils.CopyFile(c.ProjectDirectoryName+"/LICENCE", c.License.Path)
+		if err != nil {
+			log.Errorf("error while copying file [" + err.Error() + "]")
+			return err
+		}
+		// return from here as the license file has been copied
+		return nil
+	}
+	// copy license file from templates (the default one)
 	var filePaths []*string
 	// copy deployment files to generated license config files
 	targetLicenseFileName := c.ProjectDirectoryName + "/" + File

internal/utils/license-helper.go

@@ -0,0 +1,39 @@
+package utils
+
+import (
+	"fmt"
+	log "github.com/sirupsen/logrus"
+	"io"
+	"net/http"
+	"os"
+)
+
+func DownloadFile(destination, src string) error {
+	// Create blank file
+	file, err := os.Create(destination)
+	if err != nil {
+		log.Errorf("error while creating file [" + err.Error() + "]")
+		return err
+	}
+	client := http.Client{
+		CheckRedirect: func(r *http.Request, via []*http.Request) error {
+			r.URL.Opaque = r.URL.Path
+			return nil
+		},
+	}
+	// Put content on file
+	resp, err := client.Get(src)
+	if err != nil {
+		log.Errorf("error while getting file [" + err.Error() + "]")
+		return err
+	}
+	defer func(Body io.ReadCloser) {
+		_ = Body.Close()
+	}(resp.Body)
+	size, err := io.Copy(file, resp.Body)
+	defer func(file *os.File) {
+		_ = file.Close()
+	}(file)
+	fmt.Printf("Downloaded a file %s with size %d", src, size)
+	return nil
+}