environment.go

/*
Copyright The Helm Authors.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package releasetesting

import (
	"bytes"
	"fmt"
	"io/ioutil"
	"log"
	"strings"
	"sync"
	"time"

	v1 "k8s.io/api/core/v1"

	"k8s.io/helm/pkg/proto/hapi/release"
	"k8s.io/helm/pkg/proto/hapi/services"
	"k8s.io/helm/pkg/tiller/environment"
)

// logEscaper is necessary for escaping control characters found in the log stream.
var logEscaper = strings.NewReplacer("%", "%%")

// Environment encapsulates information about where test suite executes and returns results
type Environment struct {
	Namespace   string
	KubeClient  environment.KubeClient
	Stream      services.ReleaseService_RunReleaseTestServer
	Timeout     int64
	Parallel    bool
	Parallelism uint32
	streamLock  sync.Mutex
}

func (env *Environment) createTestPod(test *test) error {
	b := bytes.NewBufferString(test.manifest)
	if err := env.KubeClient.Create(env.Namespace, b, env.Timeout, false); err != nil {
		log.Printf(err.Error())
		test.result.Info = err.Error()
		test.result.Status = release.TestRun_FAILURE
		return err
	}

	return nil
}

func (env *Environment) getTestPodStatus(test *test) (v1.PodPhase, error) {
	b := bytes.NewBufferString(test.manifest)
	status, err := env.KubeClient.WaitAndGetCompletedPodPhase(env.Namespace, b, time.Duration(env.Timeout)*time.Second)
	if err != nil {
		log.Printf("Error getting status for pod %s: %s", test.result.Name, err)
		test.result.Info = err.Error()
		test.result.Status = release.TestRun_UNKNOWN
		return status, err
	}

	return status, err
}

func (env *Environment) streamResult(r *release.TestRun) error {
	switch r.Status {
	case release.TestRun_SUCCESS:
		if err := env.streamSuccess(r.Name); err != nil {
			return err
		}
	case release.TestRun_FAILURE:
		if err := env.streamFailed(r.Name); err != nil {
			return err
		}

	default:
		if err := env.streamUnknown(r.Name, r.Info); err != nil {
			return err
		}
	}
	return nil
}

func (env *Environment) streamRunning(name string) error {
	msg := "RUNNING: " + name
	return env.streamMessage(msg, release.TestRun_RUNNING)
}

func (env *Environment) streamError(info string) error {
	msg := "ERROR: " + info
	return env.streamMessage(msg, release.TestRun_FAILURE)
}

func (env *Environment) streamFailed(name string) error {
	msg := fmt.Sprintf("FAILED: %s, run `kubectl logs %s --namespace %s` for more info", name, name, env.Namespace)
	return env.streamMessage(msg, release.TestRun_FAILURE)
}

func (env *Environment) streamSuccess(name string) error {
	msg := fmt.Sprintf("PASSED: %s", name)
	return env.streamMessage(msg, release.TestRun_SUCCESS)
}

func (env *Environment) streamUnknown(name, info string) error {
	msg := fmt.Sprintf("UNKNOWN: %s: %s", name, info)
	return env.streamMessage(msg, release.TestRun_UNKNOWN)
}

func (env *Environment) streamMessage(msg string, status release.TestRun_Status) error {
	resp := &services.TestReleaseResponse{Msg: msg, Status: status}
	env.streamLock.Lock()
	defer env.streamLock.Unlock()
	return env.Stream.Send(resp)
}

// DeleteTestPods deletes resources given in testManifests
func (env *Environment) DeleteTestPods(testManifests []string) {
	for _, testManifest := range testManifests {
		err := env.KubeClient.Delete(env.Namespace, bytes.NewBufferString(testManifest))
		if err != nil {
			env.streamError(err.Error())
		}
	}
}

// GetLogs collects the logs from the pods created in testManifests
func (env *Environment) GetLogs(testManifests []string) {
	for _, testManifest := range testManifests {
		infos, err := env.KubeClient.Build(env.Namespace, bytes.NewBufferString(testManifest))
		if err != nil {
			env.streamError(err.Error())
			continue
		}
		if len(infos) == 0 {
			env.streamError(fmt.Sprint("Pod manifest is invalid. Unable to obtain the logs"))
			continue
		}
		podName := infos[0].Object.(*v1.Pod).Name
		lr, err := env.KubeClient.GetPodLogs(podName, env.Namespace)
		if err != nil {
			env.streamError(err.Error())
			continue
		}
		logs, err := ioutil.ReadAll(lr)
		if err != nil {
			env.streamError(err.Error())
			continue
		}
		msg := fmt.Sprintf("\nPOD LOGS: %s\n%s", podName, logEscaper.Replace(string(logs)))
		env.streamMessage(msg, release.TestRun_RUNNING)
	}
}