Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

NET-260 REST API tests #2351

Closed
wants to merge 25 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
fe4cd83
return 401 instead of 403
TobiaszCudnik May 22, 2023
e816a98
fixed http.StatusForbidden
TobiaszCudnik May 24, 2023
e9e2021
Tagged build version (temp)
TobiaszCudnik May 24, 2023
d1ed188
Unauthorized_Err when applicable
TobiaszCudnik May 25, 2023
d062bc2
Merge branch 'develop' into NET-163/403-insteadof-401
TobiaszCudnik May 25, 2023
abdd31b
untagged version
TobiaszCudnik May 25, 2023
dab361d
Merge branch 'develop' into NET-163/403-insteadof-401
TobiaszCudnik May 25, 2023
47543fd
fixed PUT /api/users/networks/user1
TobiaszCudnik May 25, 2023
381bb1d
- expired token redirs to login
TobiaszCudnik May 26, 2023
cec227a
Merge branch 'develop' into NET-152/enrollment-keys-for-non-admins
TobiaszCudnik May 26, 2023
577c696
handle user perms in `/hosts`
TobiaszCudnik May 29, 2023
79810a5
Merge branch 'develop' into NET-152/enrollment-keys-for-non-admins
TobiaszCudnik May 29, 2023
c619373
api test for enrollment keys
TobiaszCudnik May 29, 2023
dc5b373
removed debug
TobiaszCudnik May 29, 2023
ad4efdf
misc
TobiaszCudnik May 29, 2023
8953f41
- support masteradmin
TobiaszCudnik May 30, 2023
7551454
Merge branch 'NET-152/enrollment-keys-for-non-admins' into NET-260/re…
TobiaszCudnik May 30, 2023
4c5845b
- added masteradmin case
TobiaszCudnik May 30, 2023
06ad728
added `ismaster` to middleware
TobiaszCudnik May 30, 2023
cd662a6
Merge branch 'develop' into NET-152/enrollment-keys-for-non-admins
May 30, 2023
9096623
Merge branch 'NET-152/enrollment-keys-for-non-admins' into NET-260/re…
TobiaszCudnik May 30, 2023
908e253
inactive test for 403
TobiaszCudnik May 30, 2023
490902d
added comments
TobiaszCudnik May 31, 2023
14f1f54
Merge branch 'develop' into NET-260/rest-api-tests
May 31, 2023
513445e
Merge branch 'develop' into NET-260/rest-api-tests
Jun 6, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion database/sqlite.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,17 @@ import (
)

// == sqlite ==
const dbFilename = "netmaker.db"
var dbFilename = "netmaker.db"

func init() {
for _, p := range os.Args {
// use a different DB for testing
if p == "-test.v" {
dbFilename = "netmaker-test.db"
return
}
}
}

// SqliteDB is the db object for sqlite database connections
var SqliteDB *sql.DB
Expand Down
141 changes: 141 additions & 0 deletions test/enrollmentkey_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,141 @@
//go:build integration
// +build integration

package test

import (
"context"
"fmt"
"sync"
"testing"
"time"

"github.com/gravitl/netmaker/cli/config"
"github.com/gravitl/netmaker/cli/functions"
controller "github.com/gravitl/netmaker/controllers"
"github.com/gravitl/netmaker/database"
"github.com/gravitl/netmaker/logic"
"github.com/gravitl/netmaker/models"
"github.com/gravitl/netmaker/servercfg"
"github.com/stretchr/testify/assert"
)

func DBInit() {
database.InitializeDatabase()
database.DeleteAllRecords(database.USERS_TABLE_NAME)
database.DeleteAllRecords(database.NETWORKS_TABLE_NAME)
database.DeleteAllRecords(database.NETWORK_USER_TABLE_NAME)
database.DeleteAllRecords(database.ENROLLMENT_KEYS_TABLE_NAME)
// TODO rest
}

func TestHasNetworksAccessAPI(t *testing.T) {
// setup / teardown (TODO extract)
DBInit()
ctx, cancel := context.WithCancel(context.Background())
defer cancel()
wg := sync.WaitGroup{}
wg.Add(1)
go func() {
wg.Wait()
defer database.CloseDB()
}()
var err error
port := servercfg.GetAPIPort()
userPass := "bar123"
user := &models.User{
UserName: "foo",
Password: userPass,
// TODO should be handled in fixtures?
Networks: []string{"network-1"},
IsAdmin: false,
Groups: nil,
}
err = logic.CreateUser(user)
if err != nil {
t.Error("Error creating a user ", err)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

could use t.Fatal here?

}
// create configs
userConfig := config.Context{
Endpoint: "http://localhost:" + port,
Username: user.UserName,
Password: userPass,
}
adminConfig := userConfig
adminConfig.MasterKey = "foo123"
adminConfigBad := userConfig
adminConfigBad.MasterKey = "wrongpass"
adminConfigBad.Password = "wrongpass"
// add configs
config.SetContext("user-ctx-1", userConfig)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the context names could be extracted as variables/consts maybe, to avoid writing it wrong and facing a difficult to debug situation

config.SetContext("admin-ctx-1", adminConfig)
config.SetContext("admin-ctx-2", adminConfigBad)
// set the active config
config.SetCurrentContext("user-ctx-1")
t.Setenv("MASTER_KEY", adminConfig.MasterKey)

// fixtures
n1 := models.Network{
AddressRange: "10.101.0.0/16",
NetID: "network-1",
NodesLastModified: 1685013908,
NetworkLastModified: 1684474527,
DefaultInterface: "nm-netmaker",
DefaultListenPort: 51821,
NodeLimit: 999999999,
DefaultPostDown: "",
DefaultKeepalive: 20,
AllowManualSignUp: "no",
IsIPv4: "yes",
IsIPv6: "no",
DefaultUDPHolePunch: "no",
DefaultMTU: 1280,
DefaultACL: "yes",
ProSettings: nil,
}
_, err = logic.CreateNetwork(n1)
if err != nil {
t.Error("Error creating a network ", err)
}
// copy
n2 := n1
n2.NetID = "network-2"
_, err = logic.CreateNetwork(n2)
if err != nil {
t.Error("Error creating a network ", err)
}
k1, _ := logic.CreateEnrollmentKey(0, time.Time{}, []string{n1.NetID}, nil, true)
if err = logic.Tokenize(k1, servercfg.GetAPIHost()); err != nil {
t.Error("failed to get token values for keys:", err)
}
_, _ = logic.CreateEnrollmentKey(0, time.Time{}, []string{n2.NetID}, nil, true)
_, _ = logic.CreateEnrollmentKey(0, time.Time{}, []string{n1.NetID, n2.NetID}, nil, true)

go controller.HandleRESTRequests(&wg, ctx)
// TODO make sure that HTTP is up
time.Sleep(1 * time.Second)

t.Run("normal user", func(t *testing.T) {
keys := *functions.GetEnrollmentKeys()
assert.Len(t, keys, 1, "1 key expected")
assert.Len(t, keys[0].Networks, 1, "Key with 1 network expected")
assert.Equal(t, keys[0].Networks[0], n1.NetID, "Network ID matches")
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

are these messages not displayed on failure? honestly thought that but am not sure

assert.Equal(t, keys[0].Token, k1.Token, "Token matches")
})

t.Run("masteradmin", func(t *testing.T) {
config.SetCurrentContext("admin-ctx-1")
keys := *functions.GetEnrollmentKeys()
assert.Len(t, keys, 3, "3 keys expected")
})

// TODO assert no access
t.Run("incorrect masteradmin", func(t *testing.T) {
t.Skip("Skipping until err exposed")
config.SetCurrentContext("admin-ctx-2")
// TODO doesnt return err
res := *functions.GetEnrollmentKeys()
fmt.Println(res)
//assert.Error(t, res, "403 error")
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should probably have an assertion here, len 0?

})
}