Expose ready check to manifest (#130)

Author: ferranbt

internal/local_runner.go

@@ -313,7 +313,7 @@ func (d *LocalRunner) AreReady() bool {
 
 		// then ensure it is ready if it has a ready function
 		svc := d.getService(name)
-		if svc.readyCheck != nil {
+		if svc.ReadyCheck != nil {
 			if !task.ready {
 				return false
 			}
@@ -647,21 +647,21 @@ func (d *LocalRunner) toDockerComposeService(s *Service) (map[string]interface{}
 		service["environment"] = envs
 	}
 
-	if s.readyCheck != nil {
+	if s.ReadyCheck != nil {
 		var test []string
-		if s.readyCheck.QueryURL != "" {
+		if s.ReadyCheck.QueryURL != "" {
 			// This is pretty much hardcoded for now.
-			test = []string{"CMD-SHELL", "chmod +x /artifacts/scripts/query.sh && /artifacts/scripts/query.sh " + s.readyCheck.QueryURL}
+			test = []string{"CMD-SHELL", "chmod +x /artifacts/scripts/query.sh && /artifacts/scripts/query.sh " + s.ReadyCheck.QueryURL}
 		} else {
-			test = s.readyCheck.Test
+			test = s.ReadyCheck.Test
 		}
 
 		service["healthcheck"] = map[string]interface{}{
 			"test":         test,
-			"interval":     s.readyCheck.Interval.String(),
-			"timeout":      s.readyCheck.Timeout.String(),
-			"retries":      s.readyCheck.Retries,
-			"start_period": s.readyCheck.StartPeriod.String(),
+			"interval":     s.ReadyCheck.Interval.String(),
+			"timeout":      s.ReadyCheck.Timeout.String(),
+			"retries":      s.ReadyCheck.Retries,
+			"start_period": s.ReadyCheck.StartPeriod.String(),
 		}
 	}
 

internal/manifest.go

@@ -142,7 +142,7 @@ func (s *Manifest) Validate() error {
 
 			if dep.Condition == DependsOnConditionHealthy {
 				// if we depedn on the service to be healthy, it must have a ready check
-				if service.readyCheck == nil {
+				if service.ReadyCheck == nil {
 					return fmt.Errorf("service %s depends on service %s, but it does not have a ready check", ss.Name, dep.Name)
 				}
 			}
@@ -246,7 +246,7 @@ type Service struct {
 	// list of environment variables to set for the service
 	Env map[string]string `json:"env,omitempty"`
 
-	readyCheck *ReadyCheck
+	ReadyCheck *ReadyCheck `json:"ready_check,omitempty"`
 
 	DependsOn []DependsOn `json:"depends_on,omitempty"`
 
@@ -408,17 +408,17 @@ func (s *Service) WithArtifact(localPath string, artifactName string) *Service {
 }
 
 func (s *Service) WithReady(check ReadyCheck) *Service {
-	s.readyCheck = &check
+	s.ReadyCheck = &check
 	return s
 }
 
 type ReadyCheck struct {
-	QueryURL    string
-	Test        []string
-	Interval    time.Duration
-	StartPeriod time.Duration
-	Timeout     time.Duration
-	Retries     int
+	QueryURL    string        `json:"query_url"`
+	Test        []string      `json:"test"`
+	Interval    time.Duration `json:"interval"`
+	StartPeriod time.Duration `json:"start_period"`
+	Timeout     time.Duration `json:"timeout"`
+	Retries     int           `json:"retries"`
 }
 
 func (s *Service) DependsOnHealthy(name string) *Service {