fission-src/buildermgr/pkgwatcher.go

/*
Copyright 2017 The Fission 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 buildermgr

import (
	"fmt"
	"log"
	"time"

	"k8s.io/apimachinery/pkg/api/errors"
	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
	"k8s.io/apimachinery/pkg/fields"
	apiv1 "k8s.io/client-go/pkg/api/v1"
	k8sCache "k8s.io/client-go/tools/cache"

	"github.com/fission/fission"
	"github.com/fission/fission/cache"
	"github.com/fission/fission/crd"
)

type (
	packageWatcher struct {
		fissionClient    *crd.FissionClient
		podStore         k8sCache.Store
		builderNamespace string
		storageSvcUrl    string
	}
)

func makePackageWatcher(fissionClient *crd.FissionClient, getter k8sCache.Getter,
	builderNamespace string, storageSvcUrl string) *packageWatcher {

	lw := k8sCache.NewListWatchFromClient(getter, "pods", builderNamespace, fields.Everything())
	store, controller := k8sCache.NewInformer(lw, &apiv1.Pod{}, 30*time.Second, k8sCache.ResourceEventHandlerFuncs{})
	go controller.Run(make(chan struct{}))

	pkgw := &packageWatcher{
		fissionClient:    fissionClient,
		podStore:         store,
		builderNamespace: builderNamespace,
		storageSvcUrl:    storageSvcUrl,
	}
	return pkgw
}

// build helps to update package status, checks environment builder pod status and
// dispatches buildPackage to build source package into deployment package.
// Following is the steps build function takes to complete the whole process.
// 1. Check package status
// 2. Update package status to running state
// 3. Check environment builder pod status
// 4. Call buildPackage to build package
// 5. Update package resource in package ref of functions that share the same package
// 6. Update package status to succeed state
// *. Update package status to failed state,if any one of steps above failed/time out
func (pkgw *packageWatcher) build(buildCache *cache.Cache, pkg *crd.Package) {

	// Ignore non-pending state packages.
	if pkg.Status.BuildStatus != fission.BuildStatusPending {
		return
	}

	// Ignore duplicate build requests
	key := fmt.Sprintf("%v-%v", pkg.Metadata.Name, pkg.Metadata.ResourceVersion)
	err, _ := buildCache.Set(key, pkg)
	if err != nil {
		return
	}
	defer buildCache.Delete(key)

	log.Printf("Start build for package %v with resource version %v", pkg.Metadata.Name, pkg.Metadata.ResourceVersion)

	pkg, err = updatePackage(pkgw.fissionClient, pkg, fission.BuildStatusRunning, "", nil)
	if err != nil {
		e := fmt.Sprintf("Error setting package pending state: %v", err)
		log.Println(e)
		updatePackage(pkgw.fissionClient, pkg, fission.BuildStatusFailed, e, nil)
		return
	}

	env, err := pkgw.fissionClient.Environments(pkg.Spec.Environment.Namespace).Get(pkg.Spec.Environment.Name)
	if errors.IsNotFound(err) {
		updatePackage(pkgw.fissionClient, pkg,
			fission.BuildStatusFailed, "Environment not existed", nil)
		return
	}

	// Do health check for environment builder pod
	for i := 0; i < 15; i++ {
		// Informer store is not able to use label to find the pod,
		// iterate all available environment builders.
		items := pkgw.podStore.List()
		if err != nil {
			log.Printf("Error retrieving pod information for env %v: %v", err, env.Metadata.Name)
			return
		}

		if len(items) == 0 {
			log.Printf("Environment \"%v\" builder pod is not existed yet, retry again later.", pkg.Spec.Environment.Name)
			time.Sleep(time.Duration(i*1) * time.Second)
			continue
		}

		for _, item := range items {
			pod := item.(*apiv1.Pod)

			// Filter non-matching pods
			if pod.ObjectMeta.Labels[LABEL_ENV_NAME] != env.Metadata.Name ||
				pod.ObjectMeta.Labels[LABEL_ENV_RESOURCEVERSION] != env.Metadata.ResourceVersion {
				continue
			}

			// Pod may become "Running" state but still failed at health check, so use
			// pod.Status.ContainerStatuses instead of pod.Status.Phase to check pod readiness states.
			podIsReady := true

			for _, cStatus := range pod.Status.ContainerStatuses {
				podIsReady = podIsReady && cStatus.Ready
			}

			if !podIsReady {
				log.Printf("Environment \"%v\" builder pod is not ready, retry again later.", pkg.Spec.Environment.Name)
				time.Sleep(time.Duration(i*1) * time.Second)
				break
			}

			uploadResp, buildLogs, err := buildPackage(pkgw.fissionClient,
				pkgw.builderNamespace, pkgw.storageSvcUrl, pkg)
			if err != nil {
				log.Printf("Error building package %v: %v", pkg.Metadata.Name, err)
				updatePackage(pkgw.fissionClient, pkg, fission.BuildStatusFailed, buildLogs, nil)
				return
			}

			log.Printf("Start updating info of package: %v", pkg.Metadata.Name)

			fnList, err := pkgw.fissionClient.
				Functions(metav1.NamespaceDefault).List(metav1.ListOptions{})
			if err != nil {
				e := fmt.Sprintf("Error getting function list: %v", err)
				log.Println(e)
				buildLogs += fmt.Sprintf("%v\n", e)
				updatePackage(pkgw.fissionClient, pkg, fission.BuildStatusFailed, buildLogs, nil)
			}

			// A package may be used by multiple functions. Update
			// functions with old package resource version
			for _, fn := range fnList.Items {
				if fn.Spec.Package.PackageRef.Name == pkg.Metadata.Name &&
					fn.Spec.Package.PackageRef.Namespace == pkg.Metadata.Namespace &&
					fn.Spec.Package.PackageRef.ResourceVersion != pkg.Metadata.ResourceVersion {
					fn.Spec.Package.PackageRef.ResourceVersion = pkg.Metadata.ResourceVersion
					// update CRD
					_, err = pkgw.fissionClient.Functions(fn.Metadata.Namespace).Update(&fn)
					if err != nil {
						e := fmt.Sprintf("Error updating function package resource version: %v", err)
						log.Println(e)
						buildLogs += fmt.Sprintf("%v\n", e)
						updatePackage(pkgw.fissionClient, pkg, fission.BuildStatusFailed, buildLogs, nil)
						return
					}
				}
			}

			_, err = updatePackage(pkgw.fissionClient, pkg,
				fission.BuildStatusSucceeded, buildLogs, uploadResp)
			if err != nil {
				log.Printf("Error update package info: %v", err)
				updatePackage(pkgw.fissionClient, pkg, fission.BuildStatusFailed, buildLogs, nil)
				return
			}

			log.Printf("Completed build request for package: %v", pkg.Metadata.Name)
			return
		}
	}
	// build timeout
	updatePackage(pkgw.fissionClient, pkg,
		fission.BuildStatusFailed, "Build timeout due to environment builder not ready", nil)
	return
}

func (pkgw *packageWatcher) watchPackages() {
	buildCache := cache.MakeCache(0, 0)
	lw := k8sCache.NewListWatchFromClient(pkgw.fissionClient.GetCrdClient(), "packages", apiv1.NamespaceDefault, fields.Everything())
	_, controller := k8sCache.NewInformer(lw, &crd.Package{}, 60*time.Second, k8sCache.ResourceEventHandlerFuncs{
		AddFunc: func(obj interface{}) {
			pkg := obj.(*crd.Package)
			go pkgw.build(buildCache, pkg)
		},
		UpdateFunc: func(oldObj, newObj interface{}) {
			pkg := newObj.(*crd.Package)
			go pkgw.build(buildCache, pkg)
		},
	})
	controller.Run(make(chan struct{}))
}