dm/appengine/mutate/record_completion_test.go

// Copyright 2015 The LUCI 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 mutate

import (
	"context"
	"testing"

	"go.chromium.org/luci/dm/api/service/v1"
	"go.chromium.org/luci/dm/appengine/model"
	"go.chromium.org/luci/gae/impl/memory"
	ds "go.chromium.org/luci/gae/service/datastore"
	"go.chromium.org/luci/tumble"

	. "github.com/smartystreets/goconvey/convey"
)

func TestRecordCompletion(t *testing.T) {
	t.Parallel()

	Convey("RecordCompletion", t, func() {
		c := memory.Use(context.Background())
		rc := &RecordCompletion{dm.NewAttemptID("quest", 1)}

		bdg := &model.BackDepGroup{Dependee: *rc.For}

		Convey("Root", func() {
			So(rc.Root(c).String(), ShouldEqual, `dev~app::/BackDepGroup,"quest|fffffffe"`)
		})

		Convey("RollForward", func() {

			Convey("Good", func() {
				Convey("No BDG", func() {
					muts, err := rc.RollForward(c)
					So(err, ShouldBeNil)
					So(muts, ShouldBeEmpty)

					So(ds.Get(c, bdg), ShouldBeNil)
					So(bdg.AttemptFinished, ShouldBeTrue)
				})

				Convey("BDG exists, no deps", func() {
					So(ds.Put(c, bdg), ShouldBeNil)

					muts, err := rc.RollForward(c)
					So(err, ShouldBeNil)
					So(muts, ShouldBeEmpty)

					So(ds.Get(c, bdg), ShouldBeNil)
					So(bdg.AttemptFinished, ShouldBeTrue)
				})

				Convey("BDG exists, with unfinished deps", func() {
					bd := &model.BackDep{
						Depender:      *dm.NewAttemptID("from", 1),
						DependeeGroup: rc.Root(c),
					}
					So(ds.Put(c, bdg, bd), ShouldBeNil)

					muts, err := rc.RollForward(c)
					So(err, ShouldBeNil)
					So(muts, ShouldResemble, []tumble.Mutation{&AckFwdDep{bd.Edge()}})

					So(ds.Get(c, bdg, bd), ShouldBeNil)
					So(bdg.AttemptFinished, ShouldBeTrue)
					So(bd.Propagated, ShouldBeTrue)
				})

				Convey("BDG exists, with finished deps", func() {
					bd := &model.BackDep{
						Depender:      *dm.NewAttemptID("from", 1),
						DependeeGroup: rc.Root(c),
						Propagated:    true,
					}
					So(ds.Put(c, bdg, bd), ShouldBeNil)

					muts, err := rc.RollForward(c)
					So(err, ShouldBeNil)
					So(muts, ShouldBeEmpty)

					So(ds.Get(c, bdg, bd), ShouldBeNil)
					So(bdg.AttemptFinished, ShouldBeTrue)
					So(bd.Propagated, ShouldBeTrue)
				})

				Convey("BDG exists, but too much to do in one TXN!", func() {
					// amtWork is 1.5*completionLimit
					amtWork := completionLimit + (completionLimit >> 1)

					for i := 0; i < amtWork; i++ {
						bd := &model.BackDep{
							Depender:      *dm.NewAttemptID("from", 0),
							DependeeGroup: rc.Root(c),
						}
						bd.Depender.Id = uint32(i + 1)
						So(ds.Put(c, bd), ShouldBeNil)
					}
					So(ds.Put(c, bdg), ShouldBeNil)

					muts, err := rc.RollForward(c)
					So(err, ShouldBeNil)
					So(len(muts), ShouldEqual, completionLimit+1)

					So(muts[completionLimit], ShouldResemble, rc)

					muts, err = rc.RollForward(c)
					So(err, ShouldBeNil)
					So(len(muts), ShouldEqual, amtWork-completionLimit)

					muts, err = rc.RollForward(c)
					So(err, ShouldBeNil)
					So(muts, ShouldBeEmpty)
				})
			})
		})
	})
}