asteris-llc/converge

// Copyright © 2016 Asteris, LLC
//
// 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 plan_test

import (
    "testing"

    "github.com/asteris-llc/converge/graph"
    "github.com/asteris-llc/converge/graph/node"
    "github.com/asteris-llc/converge/helpers/faketask"
    "github.com/asteris-llc/converge/helpers/logging"
    "github.com/asteris-llc/converge/plan"
    "github.com/stretchr/testify/assert"
    "github.com/stretchr/testify/require"
    "golang.org/x/net/context"
)

func TestPlanNoOp(t *testing.T) {
    defer logging.HideLogs(t)()

    g := graph.New()
    task := faketask.NoOp()
    g.Add(node.New("root", task))

    require.NoError(t, g.Validate())

    // test that running this results in an appropriate result
    planned, err := plan.Plan(context.Background(), g)
    assert.NoError(t, err)

    result := getResult(t, planned, "root")
    assert.Equal(t, task.Status, result.Status.Messages()[0])
    assert.False(t, result.Status.HasChanges())
    assert.Equal(t, task, result.Task)
}

// TestPlanNilAndError test for panics in plan/pipeline.go
func TestPlanNilAndError(t *testing.T) {
    g := graph.New()
    task := faketask.NilAndError()
    g.Add(node.New("root", task))

    // test that running this results in an appropriate result
    planned, err := plan.Plan(context.Background(), g)
    assert.Error(t, err)

    result := getResult(t, planned, "root")

    assert.False(t, result.Status.HasChanges())
    assert.Equal(t, task, result.Task)
}

func TestPlanErrorsBelow(t *testing.T) {
    defer logging.HideLogs(t)()

    g := graph.New()
    g.Add(node.New("root", faketask.NoOp()))
    g.Add(node.New("root/err", faketask.Error()))

    g.Connect("root", "root/err")

    require.NoError(t, g.Validate())

    // planning will return an error if any of the leaves error, but it won't even
    // touch vertices that are higher up. This test should show an error in the
    // leafmost node, and not the root.
    out, err := plan.Plan(context.Background(), g)
    assert.Equal(t, plan.ErrTreeContainsErrors, err)

    errMeta, ok := out.Get("root/err")
    require.True(t, ok)
    errNode, ok := errMeta.Value().(*plan.Result)
    require.True(t, ok)
    assert.Error(t, errNode.Error())

    rootMeta, ok := out.Get("root")
    require.True(t, ok)
    rootNode, ok := rootMeta.Value().(*plan.Result)
    require.True(t, ok)
    assert.EqualError(t, rootNode.Error(), `error in dependency "root/err"`)
}

func getResult(t *testing.T, src *graph.Graph, key string) *plan.Result {
    meta, ok := src.Get(key)
    require.True(t, ok, "%q was not present in the graph", key)

    result, ok := meta.Value().(*plan.Result)
    require.True(t, ok, "needed a %T for %q, got a %T", result, key, meta.Value())

    return result
}