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.

Sign up for GitHub

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

Add Alias @pmf for @pmFromFile #1291

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
+29 −1
Open

Add Alias @pmf for @pmFromFile #1291

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
13d71ef
Add Alias `@pmf` for `@pmFromFile`
satwiksps Jan 22, 2025
e173f73
Removed redundant tests for pmFromFile
satwiksps Jan 22, 2025
bee8142
Merge branch 'main' into main
satwiksps Jan 22, 2025
9ef8c99
Merge branch 'corazawaf:main' into main
satwiksps Jan 23, 2025
4993375
Merge branch 'corazawaf:main' into main
satwiksps Jan 25, 2025
84ba70c
Merge branch 'main' into main
jcchavezs Feb 11, 2025
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
3 changes: 2 additions & 1 deletion internal/operators/pm_from_file.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,5 +51,6 @@ func newPMFromFile(options plugintypes.OperatorOptions) (plugintypes.Operator, e
}

func init() {
Register("pmFromFile", newPMFromFile)
Register("pmFromFile", newPMFromFile)
Register("pmf", newPMFromFile)
}
27 changes: 27 additions & 0 deletions internal/operators/pm_from_file_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
package operators
import (
"testing"

"github.com/corazawaf/coraza/v3/experimental/plugins/plugintypes"
)
func TestPmFromFileAlias(t *testing.T) {
Copy link
Member

Choose a reason for hiding this comment

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

Does this describe the actual test?

I think the test only compares the pm and pmfromfile operators. Not the alias.

Copy link
Member

Choose a reason for hiding this comment

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

I would just get rid of the test here as it is not testing that pmf actually does what it is supposed to.

Copy link
Member

Choose a reason for hiding this comment

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

@satwiksps This test can easily be extended testing the alias alongside @pmfromfile https://github.com/corazawaf/coraza/blob/9293be843709277bf32ca6e2cada40775a19ab4a/testing/engine/operators_with_files.go

opts := plugintypes.OperatorOptions{
Arguments: "test_1",
Datasets: map[string][]string{
"test_1": {"value1", "value2"},
},
}
pm, err := newPM(opts)
if err != nil {
t.Fatalf("Failed to initialize pm: %v", err)
}
pmFromFile, err := newPMFromFile(opts)
if err != nil {
t.Fatalf("Failed to initialize pmFromFile: %v", err)
}
input := "value1"
if pm.Evaluate(nil, input) != pmFromFile.Evaluate(nil, input) {
t.Errorf("pm and pmFromFile returned different results for input: %s", input)
}
}