close #191 separate repo and issue configuration

Author: groenborg

.phlow

@@ -2,15 +2,13 @@
     integration_branch = master
     remote = origin
     service = github
+    issue_url = https://api.github.com
+    pipeline_url = http://concourse.bosh.praqma.cloud/teams/main/pipelines/git-phlow
     delivery_branch_prefix = ready
 [jira]
+    service = sd
     integration_branch = gh_pages
     remote = fork
-    service = jira
-    delivery_branch_prefix = integrateme
-
-[gitlab]
-    integration_branch = gh_pages
-    remote = fork
-    service = jira
+    repo_url = jira
+    issue_url = jira
     delivery_branch_prefix = integrateme

docs/README.md

@@ -0,0 +1,41 @@
+### Configuration
+git phlow is configured via `.phlow`, or `.gitignore`  files., in your local workspace or in the home folder of your computer. The configuration is standard INI files, just like gitconfig.
+
+#### Config Block
+Each configuration is has it's own block which can be used either by setting the block name to `[default]` or by specifying which configuration you want to use by setting it in the git phlow command.
+
+A block consists of following fields.
+
+- `integration_branch` The name of your default integration branch. normally it's `master`
+- `remote` The name of your remote. By default git sets this to `origin`
+- `service` The service you use for issues.
+- `issue_url` The url to your service where issues are hosted and managed
+- `delivery_branch_prefix` The prefix you want your pretested integration system to look for
+
+#### Supported services
+-  `github`
+-  ~~`jira`~~ -  coming soon
+
+
+#### Example Configuration
+```ini
+[name]
+    integration_branch = master
+    remote = origin
+    service = github
+    issue_url = https://api.github.com
+    pipeline_url = http://concourse.bosh.praqma.cloud/teams/main/pipelines/git-phlow #optional
+    delivery_branch_prefix = ready
+```
+
+#### Internal Default
+If no  `.phlow` or `.gitconfig` files are located, git phlow will use an interal default configuration.  The internal configuration is the last resort, and it is strongly recommended to use `.phlow` to keep your projects configuration, even though it mimiks the default.
+
+```ini
+[default]
+    integration_branch = master
+    remote = origin
+    service = github
+    issue_url = https://api.github.com
+    delivery_branch_prefix = ready
+``` 

main.go

@@ -1,8 +1,16 @@
 package main
 
-import "github.com/praqma/git-phlow/cmd"
+import (
+	"github.com/praqma/git-phlow/setting"
+	"fmt"
+)
 
 func main() {
-	cmd.Execute()
+	//cmd.Execute()
+
+	proj := setting.NewProjectStg("default")
+
+	err := setting.ValidateLoadedSetting(proj)
+	fmt.Println(err)
 
 }

setting/setting.go

@@ -6,6 +6,8 @@ import (
 	"github.com/praqma/git-phlow/executor"
 	"github.com/go-ini/ini"
 	"fmt"
+	"reflect"
+	"github.com/go-errors/errors"
 )
 
 //Load internals
@@ -17,12 +19,14 @@ const (
 
 //Default configuration
 const (
+	internal_default_service                = "github"
 	internal_default_integration_branch     = "master"
 	internal_default_remote                 = "origin"
-	internal_default_service                = "github"
+	internal_default_issue_url              = "https://api.github.com"
 	internal_default_delivery_branch_prefix = "ready"
 	internal_default_scope                  = "internal"
 	internal_default_file                   = "none"
+	internal_pipeline_url                   = "none"
 )
 
 //Uses git config commandline interface
@@ -35,12 +39,15 @@ type ToolsSetting struct {
 
 //ProjectSetting ...
 type ProjectSetting struct {
+	Service              string `ini:"service"`
 	IntegrationBranch    string `ini:"integration_branch"`
 	Remote               string `ini:"remote"`
-	Service              string `ini:"service"`
+	IssueURL             string `ini:"issue_url"`
+	PipelineUrl          string `ini:"pipeline"`
 	DeliveryBranchPrefix string `ini:"delivery_branch_prefix"`
 	Scope                string
 	File                 string
+	INIBlock             string
 }
 
 //NewProjectStg ...
@@ -102,10 +109,12 @@ func LoadProjectSettings(local, global string, INIBlock string) *ProjectSetting
 		}
 		//return internal default because no other configuration exist and no other is specified by params
 		return &ProjectSetting{
+			Service:              internal_default_service,
 			IntegrationBranch:    internal_default_integration_branch,
 			Remote:               internal_default_remote,
-			Service:              internal_default_service,
+			IssueURL:             internal_default_issue_url,
 			DeliveryBranchPrefix: internal_default_delivery_branch_prefix,
+			PipelineUrl:          internal_pipeline_url,
 			Scope:                internal_default_scope,
 			File:                 internal_default_file,
 		}
@@ -118,10 +127,50 @@ func LoadProjectSettings(local, global string, INIBlock string) *ProjectSetting
 	//Add configuration origin
 	conf.File = configFile
 	conf.Scope = configScope
+	conf.INIBlock = INIBlock
 
+	if err := ValidateLoadedSetting(conf); err != nil {
+		fmt.Println(err)
+		os.Exit(1)
+	}
 	return conf
 }
 
+//ValidateLoadedSetting ...
+func ValidateLoadedSetting(setting *ProjectSetting) (error) {
+	r := reflect.ValueOf(setting).Elem()
+	t := r.Type()
+
+	//Non Optional Field checks..
+	for i := 0; i < t.NumField(); i++ {
+		if t.Field(i).Name == "Service" && (r.Field(i).String() == "") {
+			return errors.New(fmt.Sprintf("Error in configuration file: %s \n"+
+				"Non-optional field missing: %s \n In configuration block: %s \n ", setting.Scope+"/"+setting.File, "service", setting.INIBlock))
+		}
+
+		if t.Field(i).Name == "IssueURL" && r.Field(i).String() == "" {
+			return errors.New(fmt.Sprintf("Error in configuration file: %s \n"+
+				"Non-optional field missing: %s \n In configuration block: %s \n ", setting.Scope+"/"+setting.File, "issue_url", setting.INIBlock))
+		}
+
+		if t.Field(i).Name == "IntegrationBranch" && r.Field(i).String() == "" {
+			return errors.New(fmt.Sprintf("Error in configuration file: %s \n"+
+				"Non-optional field missing: %s \n In configuration block: %s \n ", setting.Scope+"/"+setting.File, "integration_branch", setting.INIBlock))
+		}
+
+		if t.Field(i).Name == "Remote" && r.Field(i).String() == "" {
+			return errors.New(fmt.Sprintf("Error in configuration file: %s \n"+
+				"Non-optional field missing: %s \n In configuration block: %s \n ", setting.Scope+"/"+setting.File, "remote", setting.INIBlock))
+		}
+
+		if t.Field(i).Name == "DeliveryBranchPrefix" && r.Field(i).String() == "" {
+			return errors.New(fmt.Sprintf("Error in configuration file: %s \n"+
+				"Non-optional field missing: %s \n In configuration block: %s \n ", setting.Scope+"/"+setting.File, "delivery_branch_prefix", setting.INIBlock))
+		}
+	}
+	return nil
+}
+
 //LoadToolSettings ...
 func LoadToolSettings(run executor.Runner) *ToolsSetting {
 	var set = ToolsSetting{}

setting/setting_test.go

@@ -52,31 +52,90 @@ var _ = Describe("Setting", func() {
 	Describe("LoadProjectSetting", func() {
 
 		It("should return find local default", func() {
-
 			conf := setting.LoadProjectSettings(setting.GetLocal(), "", "default")
 			Ω(conf.File).Should(Equal(".phlow"))
-			Ω(conf.Service).Should(Equal("github"))
-
+			Ω(conf.IssueURL).Should(Equal("https://api.github.com"))
 		})
 
 		It("should find local jira", func() {
 			conf := setting.LoadProjectSettings(setting.GetLocal(), "", "jira")
 			Ω(conf.File).Should(Equal(".phlow"))
-			Ω(conf.Service).Should(Equal("jira"))
+			Ω(conf.IssueURL).Should(Equal("jira"))
 		})
 
 		It("no params should set default", func() {
 			conf := setting.LoadProjectSettings(setting.GetLocal(), "", "")
 			Ω(conf.File).Should(Equal(".phlow"))
-			Ω(conf.Service).Should(Equal("github"))
+			Ω(conf.IssueURL).Should(Equal("https://api.github.com"))
 		})
 
-
 		It("no config files should use internal default", func() {
 			conf := setting.LoadProjectSettings("", "", "")
 			Ω(conf.File).Should(Equal("none"))
 			Ω(conf.Scope).Should(Equal("internal"))
 		})
 	})
 
+	Describe("Test Validation for non-optional params", func() {
+		var set = setting.ProjectSetting{}
+
+		BeforeEach(func() {
+			set = setting.ProjectSetting{
+				Service:              "not empty",
+				IntegrationBranch:    "not empty",
+				DeliveryBranchPrefix: "not empty",
+				Remote:               "not empty",
+				IssueURL:             "not empty",
+				PipelineUrl:          "not empty"}
+
+		})
+
+		Context("With missing IssueUrl", func() {
+			It("Should return error", func() {
+				set.IssueURL = ""
+				err := setting.ValidateLoadedSetting(&set)
+				Ω(err).ShouldNot(BeNil())
+
+			})
+
+		})
+
+		Context("With missing remote", func() {
+			It("Should return error", func() {
+				set.Remote = ""
+				err := setting.ValidateLoadedSetting(&set)
+				Ω(err).ShouldNot(BeNil())
+
+			})
+
+		})
+
+		Context("With missing branch prefix", func() {
+			It("Should return error", func() {
+				set.DeliveryBranchPrefix = ""
+				err := setting.ValidateLoadedSetting(&set)
+				Ω(err).ShouldNot(BeNil())
+
+			})
+
+		})
+
+		Context("With missing integration branch", func() {
+			It("Should return error", func() {
+				set.IntegrationBranch = ""
+				err := setting.ValidateLoadedSetting(&set)
+				Ω(err).ShouldNot(BeNil())
+			})
+		})
+
+		Context("With missing service", func() {
+			It("Should return error", func() {
+				set.Service = ""
+				err := setting.ValidateLoadedSetting(&set)
+				Ω(err).ShouldNot(BeNil())
+			})
+		})
+
+	})
+
 })