-
-
Notifications
You must be signed in to change notification settings - Fork 213
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: implement ContextAdapter interface (#222)
* feat: context adapter * fix: fix db connection * fix: fix db connection * fix: fix db connection * fix: fix db connection * Update context_adapter.go * Update context_adapter_test.go * Update context_adapter_test.go --------- Co-authored-by: hsluoyz <hsluoyz@qq.com>
- Loading branch information
1 parent
bb83b9a
commit 6f78166
Showing
5 changed files
with
260 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,85 @@ | ||
| // Copyright 2023 The casbin Authors. All Rights Reserved. | ||
| // | ||
| // 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 gormadapter | ||
|
|
||
| import ( | ||
| "context" | ||
|
|
||
| "github.com/casbin/casbin/v2/model" | ||
| ) | ||
|
|
||
| type ContextAdapter struct { | ||
| *Adapter | ||
| } | ||
|
|
||
| func NewContextAdapter(driverName string, dataSourceName string, params ...interface{}) (*ContextAdapter, error) { | ||
| a, err := NewAdapter(driverName, dataSourceName, params...) | ||
| return &ContextAdapter{ | ||
| a, | ||
| }, err | ||
| } | ||
|
|
||
| // executeWithContext is a helper function to execute a function with context and return the result or error. | ||
| func executeWithContext(ctx context.Context, fn func() error) error { | ||
| done := make(chan error) | ||
| go func() { | ||
| done <- fn() | ||
| }() | ||
|
|
||
| select { | ||
| case <-ctx.Done(): | ||
| return ctx.Err() | ||
| case err := <-done: | ||
| return err | ||
| } | ||
| } | ||
|
|
||
| // LoadPolicyCtx loads all policy rules from the storage with context. | ||
| func (ca *ContextAdapter) LoadPolicyCtx(ctx context.Context, model model.Model) error { | ||
| return executeWithContext(ctx, func() error { | ||
| return ca.LoadPolicy(model) | ||
| }) | ||
| } | ||
|
|
||
| // SavePolicyCtx saves all policy rules to the storage with context. | ||
| func (ca *ContextAdapter) SavePolicyCtx(ctx context.Context, model model.Model) error { | ||
| return executeWithContext(ctx, func() error { | ||
| return ca.SavePolicy(model) | ||
| }) | ||
| } | ||
|
|
||
| // AddPolicyCtx adds a policy rule to the storage with context. | ||
| // This is part of the Auto-Save feature. | ||
| func (ca *ContextAdapter) AddPolicyCtx(ctx context.Context, sec string, ptype string, rule []string) error { | ||
| return executeWithContext(ctx, func() error { | ||
| return ca.AddPolicy(sec, ptype, rule) | ||
| }) | ||
| } | ||
|
|
||
| // RemovePolicyCtx removes a policy rule from the storage with context. | ||
| // This is part of the Auto-Save feature. | ||
| func (ca *ContextAdapter) RemovePolicyCtx(ctx context.Context, sec string, ptype string, rule []string) error { | ||
| return executeWithContext(ctx, func() error { | ||
| return ca.RemovePolicy(sec, ptype, rule) | ||
| }) | ||
| } | ||
|
|
||
| // RemoveFilteredPolicyCtx removes policy rules that match the filter from the storage with context. | ||
| // This is part of the Auto-Save feature. | ||
| func (ca *ContextAdapter) RemoveFilteredPolicyCtx(ctx context.Context, sec string, ptype string, fieldIndex int, fieldValues ...string) error { | ||
| return executeWithContext(ctx, func() error { | ||
| return ca.RemoveFilteredPolicy(sec, ptype, fieldIndex, fieldValues...) | ||
| }) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,141 @@ | ||
| // Copyright 2023 The casbin Authors. All Rights Reserved. | ||
| // | ||
| // 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 gormadapter | ||
|
|
||
| import ( | ||
| "context" | ||
| "testing" | ||
| "time" | ||
|
|
||
| "github.com/agiledragon/gomonkey/v2" | ||
| "github.com/casbin/casbin/v2" | ||
| "github.com/stretchr/testify/assert" | ||
| ) | ||
|
|
||
| func mockExecuteWithContextTimeOut(ctx context.Context, fn func() error) error { | ||
| done := make(chan error) | ||
| go func() { | ||
| time.Sleep(500 * time.Microsecond) | ||
| done <- fn() | ||
| }() | ||
|
|
||
| select { | ||
| case <-ctx.Done(): | ||
| return ctx.Err() | ||
| case err := <-done: | ||
| return err | ||
| } | ||
| } | ||
|
|
||
| func clearDBPolicy() (*casbin.Enforcer, *ContextAdapter) { | ||
| ca, err := NewContextAdapter("mysql", "root:@tcp(127.0.0.1:3306)/", "casbin") | ||
| if err != nil { | ||
| panic(err) | ||
| } | ||
| e, err := casbin.NewEnforcer("examples/rbac_model.conf", ca) | ||
| if err != nil { | ||
| panic(err) | ||
| } | ||
| e.ClearPolicy() | ||
| _ = e.SavePolicy() | ||
|
|
||
| return e, ca | ||
| } | ||
|
|
||
| func TestContextAdapter_LoadPolicyCtx(t *testing.T) { | ||
| e, ca := clearDBPolicy() | ||
|
|
||
| db, _ := openDBConnection("mysql", "root:@tcp(127.0.0.1:3306)/casbin") | ||
| policy := &CasbinRule{ | ||
| Ptype: "p", | ||
| V0: "alice", | ||
| V1: "data1", | ||
| V2: "read", | ||
| } | ||
| db.Create(policy) | ||
|
|
||
| assert.NoError(t, ca.LoadPolicyCtx(context.Background(), e.GetModel())) | ||
| e, _ = casbin.NewEnforcer(e.GetModel(), ca) | ||
| testGetPolicy(t, e, [][]string{{"alice", "data1", "read"}}) | ||
|
|
||
| var p = gomonkey.ApplyFunc(executeWithContext, mockExecuteWithContextTimeOut) | ||
| defer p.Reset() | ||
| ctx, cancel := context.WithTimeout(context.Background(), 300*time.Microsecond) | ||
| defer cancel() | ||
| assert.EqualError(t, ca.LoadPolicyCtx(ctx, e.GetModel()), "context deadline exceeded") | ||
| } | ||
|
|
||
| func TestContextAdapter_SavePolicyCtx(t *testing.T) { | ||
| e, ca := clearDBPolicy() | ||
|
|
||
| e.EnableAutoSave(false) | ||
| _, _ = e.AddPolicy("alice", "data1", "read") | ||
| assert.NoError(t, ca.SavePolicyCtx(context.Background(), e.GetModel())) | ||
| _ = e.LoadPolicy() | ||
| testGetPolicy(t, e, [][]string{{"alice", "data1", "read"}}) | ||
|
|
||
| var p = gomonkey.ApplyFunc(executeWithContext, mockExecuteWithContextTimeOut) | ||
| defer p.Reset() | ||
| ctx, cancel := context.WithTimeout(context.Background(), 300*time.Microsecond) | ||
| defer cancel() | ||
| assert.EqualError(t, ca.SavePolicyCtx(ctx, e.GetModel()), "context deadline exceeded") | ||
| } | ||
|
|
||
| func TestContextAdapter_AddPolicyCtx(t *testing.T) { | ||
| e, ca := clearDBPolicy() | ||
|
|
||
| assert.NoError(t, ca.AddPolicyCtx(context.Background(), "p", "p", []string{"alice", "data1", "read"})) | ||
| _ = e.LoadPolicy() | ||
| testGetPolicy(t, e, [][]string{{"alice", "data1", "read"}}) | ||
|
|
||
| var p = gomonkey.ApplyFunc(executeWithContext, mockExecuteWithContextTimeOut) | ||
| defer p.Reset() | ||
| ctx, cancel := context.WithTimeout(context.Background(), 300*time.Microsecond) | ||
| defer cancel() | ||
| assert.EqualError(t, ca.AddPolicyCtx(ctx, "p", "p", []string{"alice", "data1", "read"}), "context deadline exceeded") | ||
| } | ||
|
|
||
| func TestContextAdapter_RemovePolicyCtx(t *testing.T) { | ||
| e, ca := clearDBPolicy() | ||
|
|
||
| _ = ca.AddPolicy("p", "p", []string{"alice", "data1", "read"}) | ||
| _ = ca.AddPolicy("p", "p", []string{"alice", "data2", "read"}) | ||
| assert.NoError(t, ca.RemovePolicyCtx(context.Background(), "p", "p", []string{"alice", "data1", "read"})) | ||
| _ = e.LoadPolicy() | ||
| testGetPolicy(t, e, [][]string{{"alice", "data2", "read"}}) | ||
|
|
||
| var p = gomonkey.ApplyFunc(executeWithContext, mockExecuteWithContextTimeOut) | ||
| defer p.Reset() | ||
| ctx, cancel := context.WithTimeout(context.Background(), 300*time.Microsecond) | ||
| defer cancel() | ||
| assert.EqualError(t, ca.RemovePolicyCtx(ctx, "p", "p", []string{"alice", "data1", "read"}), "context deadline exceeded") | ||
| } | ||
|
|
||
| func TestContextAdapter_RemoveFilteredPolicyCtx(t *testing.T) { | ||
| e, ca := clearDBPolicy() | ||
|
|
||
| _ = ca.AddPolicy("p", "p", []string{"alice", "data1", "read"}) | ||
| _ = ca.AddPolicy("p", "p", []string{"alice", "data1", "write"}) | ||
| _ = ca.AddPolicy("p", "p", []string{"alice", "data2", "read"}) | ||
| assert.NoError(t, ca.RemoveFilteredPolicyCtx(context.Background(), "p", "p", 1, "data1")) | ||
| _ = e.LoadPolicy() | ||
| testGetPolicy(t, e, [][]string{{"alice", "data2", "read"}}) | ||
|
|
||
| var p = gomonkey.ApplyFunc(executeWithContext, mockExecuteWithContextTimeOut) | ||
| defer p.Reset() | ||
| ctx, cancel := context.WithTimeout(context.Background(), 300*time.Microsecond) | ||
| defer cancel() | ||
| assert.EqualError(t, ca.RemoveFilteredPolicyCtx(ctx, "p", "p", 1, "data1"), "context deadline exceeded") | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters