Round out service tests

* Add tests for service Target and catch a panic
 * Add skipped stub test for Task w/ a note for future us
This commit is contained in:
Paul Hinze 2021-12-17 16:13:24 -06:00
parent 72c72c4f53
commit c1c215e84e
No known key found for this signature in database
GPG Key ID: B69DEDF2D55501C0
5 changed files with 191 additions and 1 deletions

View File

@ -0,0 +1,127 @@
package singleprocess
import (
"context"
"testing"
"github.com/hashicorp/vagrant-plugin-sdk/proto/vagrant_plugin_sdk"
"github.com/hashicorp/vagrant/internal/server"
"github.com/hashicorp/vagrant/internal/server/proto/vagrant_server"
"github.com/stretchr/testify/require"
"google.golang.org/protobuf/types/known/emptypb"
)
func TestServiceTarget(t *testing.T) {
ctx := context.Background()
t.Run("set and get", func(t *testing.T) {
require := require.New(t)
db := testDB(t)
impl, err := New(WithDB(db))
require.NoError(err)
client := server.TestServer(t, impl)
// need a basis and a project to have a target
basisResp, err := client.UpsertBasis(ctx, &vagrant_server.UpsertBasisRequest{
Basis: &vagrant_server.Basis{
Name: "mybasis",
},
})
require.NoError(err)
projectResp, err := client.UpsertProject(ctx, &vagrant_server.UpsertProjectRequest{
Project: &vagrant_server.Project{
Name: "myproject",
Basis: &vagrant_plugin_sdk.Ref_Basis{ResourceId: basisResp.Basis.ResourceId},
},
})
require.NoError(err)
projectRef := &vagrant_plugin_sdk.Ref_Project{ResourceId: projectResp.Project.ResourceId}
resp, err := client.UpsertTarget(ctx, &vagrant_server.UpsertTargetRequest{
Target: &vagrant_server.Target{
Name: "mytarget",
Project: projectRef,
},
})
require.NoError(err)
require.NotNil(resp)
require.Equal("mytarget", resp.Target.Name)
})
t.Run("find and list and delete", func(t *testing.T) {
require := require.New(t)
db := testDB(t)
impl, err := New(WithDB(db))
require.NoError(err)
client := server.TestServer(t, impl)
// first insert
basisResp, err := client.UpsertBasis(ctx, &vagrant_server.UpsertBasisRequest{
Basis: &vagrant_server.Basis{
Name: "mybasis",
},
})
require.NoError(err)
projectResp, err := client.UpsertProject(ctx, &vagrant_server.UpsertProjectRequest{
Project: &vagrant_server.Project{
Name: "myproject",
Basis: &vagrant_plugin_sdk.Ref_Basis{ResourceId: basisResp.Basis.ResourceId},
},
})
projectRef := &vagrant_plugin_sdk.Ref_Project{ResourceId: projectResp.Project.ResourceId}
_, err = client.UpsertTarget(ctx, &vagrant_server.UpsertTargetRequest{
Target: &vagrant_server.Target{
Name: "mytarget",
Project: projectRef,
},
})
require.NoError(err)
// see if we can find it by name & project
findResp, err := client.FindTarget(ctx, &vagrant_server.FindTargetRequest{
Target: &vagrant_server.Target{Project: projectRef, Name: "mytarget"},
})
require.NoError(err)
require.NotNil(findResp)
require.Equal("mytarget", findResp.Target.Name)
// then ensure it shows up in a list
listResp, err := client.ListTargets(ctx, &emptypb.Empty{})
require.NoError(err)
require.NotNil(listResp)
require.Len(listResp.Targets, 1)
// then delete it and the list should be empty
_, err = client.DeleteTarget(ctx, &vagrant_server.DeleteTargetRequest{
Target: &vagrant_plugin_sdk.Ref_Target{
ResourceId: findResp.Target.ResourceId,
Project: projectRef,
},
})
require.NoError(err)
listResp, err = client.ListTargets(ctx, &emptypb.Empty{})
require.NoError(err)
require.NotNil(listResp)
require.Len(listResp.Targets, 0)
})
t.Run("reasonable errors: set without project", func(t *testing.T) {
require := require.New(t)
db := testDB(t)
impl, err := New(WithDB(db))
require.NoError(err)
client := server.TestServer(t, impl)
_, err = client.UpsertTarget(ctx, &vagrant_server.UpsertTargetRequest{
Target: &vagrant_server.Target{
Name: "ihavenoproject",
},
})
require.Error(err)
require.Contains(err.Error(), "not found")
})
}

View File

@ -0,0 +1,50 @@
package singleprocess
import (
"context"
"testing"
"github.com/hashicorp/vagrant-plugin-sdk/proto/vagrant_plugin_sdk"
"github.com/hashicorp/vagrant/internal/server"
"github.com/hashicorp/vagrant/internal/server/proto/vagrant_server"
"github.com/stretchr/testify/require"
)
func TestServiceTask(t *testing.T) {
ctx := context.Background()
t.Run("set and get", func(t *testing.T) {
require := require.New(t)
t.Skip("We are leaving the Task Set/Get operations broken for now; see TODO in state.TaskPut")
db := testDB(t)
impl, err := New(WithDB(db))
require.NoError(err)
client := server.TestServer(t, impl)
// need a basis to have a project
_, err = client.UpsertBasis(ctx, &vagrant_server.UpsertBasisRequest{
Basis: &vagrant_server.Basis{
Name: "mybasis",
},
})
require.NoError(err)
resp, err := client.UpsertTask(ctx, &vagrant_server.UpsertTaskRequest{
Task: &vagrant_server.Task{
Scope: &vagrant_server.Task_Basis{Basis: &vagrant_plugin_sdk.Ref_Basis{Name: "mybasis"}},
Task: "mytask",
},
})
require.NoError(err)
require.NotNil(resp)
require.NotEmpty(resp.Task.Id)
require.Equal("mybasis", resp.Task.Task)
getResp, err := client.GetTask(ctx, &vagrant_server.GetTaskRequest{
Ref: &vagrant_server.Ref_Operation{Target: &vagrant_server.Ref_Operation_Id{Id: resp.Task.Id}},
})
require.NoError(err)
require.NotNil(getResp)
require.Equal("mytask", getResp.Task)
})
}

View File

@ -389,5 +389,8 @@ func (s *State) projectId(p *vagrant_server.Project) []byte {
}
func (s *State) projectIdByRef(ref *vagrant_plugin_sdk.Ref_Project) []byte {
if ref == nil {
return []byte{}
}
return []byte(ref.ResourceId)
}

View File

@ -177,7 +177,7 @@ func (s *State) targetPut(
value *vagrant_server.Target,
) (err error) {
s.log.Trace("storing target", "target", value, "project",
value.Project, "basis", value.Project.Basis)
value.GetProject(), "basis", value.GetProject().GetBasis())
p, err := s.projectGet(dbTxn, memTxn, value.Project)
if err != nil {

View File

@ -15,6 +15,16 @@ func init() {
// TaskPut inserts or updates a task record.
func (s *State) TaskPut(update bool, t *vagrant_server.Task) error {
// TODO(phinze): This Put operation will always fail because the Task
// struct has neither a Basis, a Project, nor a Target set. This is ok for
// now because nobody is using Task operations directly - Tasks seem to
// enter state only from being nested in Jobs. At some point we'll need to
// swing around and decide if we want to fix this wiring or if it's
// unnecessary and okay to delete.
//
// If we do decide to fix it... the thing to sort out here will be how to
// transform the basis, project, or target referenced by t.Scope into the
// form expected by taskOp.Put().
return taskOp.Put(s, update, t)
}