Skip to content

Fix omniv2 custom FileFormat extensibility problem #66

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

Merged
merged 3 commits into from
Sep 27, 2020
Merged

Fix omniv2 custom FileFormat extensibility problem #66

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4a2938b
Fix omniv2 custom FileFormat extensibility problem
Sep 27, 2020
6e71a1b
fix comments
Sep 27, 2020
53c7803
Simon's comment: what if HandlerParams type is incorrect
Sep 27, 2020
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
28 changes: 18 additions & 10 deletions handlers/omni/v2/handler.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ const (

// HandlerParams allows user of omniparser to provide omniv2 schema handler customization.
type HandlerParams struct {
CustomFileFormat omniv2fileformat.FileFormat
CustomParseFuncs transform.CustomParseFuncs
CustomFileFormats []omniv2fileformat.FileFormat
CustomParseFuncs transform.CustomParseFuncs
}

// CreateHandler parses, validates and creates an omni-schema based handler.
Expand All @@ -35,7 +35,8 @@ func CreateHandler(ctx *handlers.HandlerCtx) (handlers.SchemaHandler, error) {
// err is already context formatted.
return nil, err
}
finalOutputDecl, err := transform.ValidateTransformDeclarations(ctx.Content, ctx.CustomFuncs, customParseFuncs(ctx))
finalOutputDecl, err := transform.ValidateTransformDeclarations(
ctx.Content, ctx.CustomFuncs, customParseFuncs(ctx))
if err != nil {
return nil, fmt.Errorf(
"schema '%s' 'transform_declarations' validation failed: %s",
Expand Down Expand Up @@ -67,25 +68,32 @@ func customParseFuncs(ctx *handlers.HandlerCtx) transform.CustomParseFuncs {
if ctx.HandlerParams == nil {
return nil
}
params := ctx.HandlerParams.(*HandlerParams)
params, ok := ctx.HandlerParams.(*HandlerParams)
if !ok {
return nil
}
if len(params.CustomParseFuncs) == 0 {
return nil
}
return params.CustomParseFuncs
}

func fileFormats(ctx *handlers.HandlerCtx) []omniv2fileformat.FileFormat {
// If caller specifies a custom FileFormat, we'll use it (and it only);
// otherwise we'll use the builtin ones.
formats := []omniv2fileformat.FileFormat{
omniv2json.NewJSONFileFormat(ctx.Name),
omniv2xml.NewXMLFileFormat(ctx.Name),
// TODO more bulit-in omniv2 file formats to come.
// TODO more built-in omniv2 file formats to come.
}
if ctx.HandlerParams == nil {
return formats
}
if ctx.HandlerParams != nil && ctx.HandlerParams.(*HandlerParams).CustomFileFormat != nil {
formats = []omniv2fileformat.FileFormat{ctx.HandlerParams.(*HandlerParams).CustomFileFormat}
params, ok := ctx.HandlerParams.(*HandlerParams)
if !ok {
return formats
}
return formats
// If caller specifies a list of custom FileFormats, we'll give them priority
// over builtin ones.
return append(params.CustomFileFormats, formats...)
}

type schemaHandler struct {
Expand Down
54 changes: 37 additions & 17 deletions handlers/omni/v2/handler_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ import (
"github.com/jf-tech/omniparser/errs"
"github.com/jf-tech/omniparser/handlers"
omniv2fileformat "github.com/jf-tech/omniparser/handlers/omni/v2/fileformat"
omniv2json "github.com/jf-tech/omniparser/handlers/omni/v2/fileformat/json"
"github.com/jf-tech/omniparser/handlers/omni/v2/transform"
"github.com/jf-tech/omniparser/header"
"github.com/jf-tech/omniparser/transformctx"
Expand Down Expand Up @@ -127,24 +128,44 @@ func TestCreateHandler_TransformDeclarationsInCodeValidationFailed(t *testing.T)
assert.Nil(t, p)
}

func TestCreateHandler_CustomFileFormat_FormatNotSupported(t *testing.T) {
func TestCreateHandler_HandlerParamsTypeNotRight_Fallback(t *testing.T) {
p, err := CreateHandler(
&handlers.HandlerCtx{
Header: header.Header{
ParserSettings: header.ParserSettings{
Version: version,
Version: version,
FileFormatType: "json",
},
},
Content: []byte(`{"transform_declarations": { "FINAL_OUTPUT": {} }}`),
Content: []byte(`{"transform_declarations": { "FINAL_OUTPUT": { "xpath": "." }}}`),
HandlerParams: "not nil but not the right type",
})
assert.NoError(t, err)
assert.IsType(t, omniv2json.NewJSONFileFormat(""), p.(*schemaHandler).fileFormat)
assert.Equal(t, ".", p.(*schemaHandler).formatRuntime.(string))
}

func TestCreateHandler_CustomFileFormat_FormatNotSupported_Fallback(t *testing.T) {
p, err := CreateHandler(
&handlers.HandlerCtx{
Header: header.Header{
ParserSettings: header.ParserSettings{
Version: version,
FileFormatType: "json",
},
},
Content: []byte(`{"transform_declarations": { "FINAL_OUTPUT": { "xpath": "." }}}`),
HandlerParams: &HandlerParams{
CustomFileFormat: testFileFormat{
validateSchemaErr: errs.ErrSchemaNotSupported,
CustomFileFormats: []omniv2fileformat.FileFormat{
// Having the custom FileFormat returns ErrSchemaNotSupported
// causes it to fallback and continue probing the built-in FileFormats.
testFileFormat{validateSchemaErr: errs.ErrSchemaNotSupported},
},
},
})
assert.Error(t, err)
assert.Equal(t, "schema not supported", err.Error())
assert.Nil(t, p)
assert.NoError(t, err)
assert.IsType(t, omniv2json.NewJSONFileFormat(""), p.(*schemaHandler).fileFormat)
assert.Equal(t, ".", p.(*schemaHandler).formatRuntime.(string))
}

func TestCreateHandler_CustomFileFormat_ValidationFailure(t *testing.T) {
Expand All @@ -157,8 +178,8 @@ func TestCreateHandler_CustomFileFormat_ValidationFailure(t *testing.T) {
},
Content: []byte(`{"transform_declarations": { "FINAL_OUTPUT": {} }}`),
HandlerParams: &HandlerParams{
CustomFileFormat: testFileFormat{
validateSchemaErr: errors.New("validation failure"),
CustomFileFormats: []omniv2fileformat.FileFormat{
testFileFormat{validateSchemaErr: errors.New("validation failure")},
},
},
})
Expand All @@ -177,15 +198,14 @@ func TestCreateHandler_CustomFileFormat_Success(t *testing.T) {
},
Content: []byte(`{"transform_declarations": { "FINAL_OUTPUT": {} }}`),
HandlerParams: &HandlerParams{
CustomFileFormat: testFileFormat{
validateSchemaRuntime: "runtime data",
CustomFileFormats: []omniv2fileformat.FileFormat{
testFileFormat{validateSchemaRuntime: "runtime data"},
},
},
})
assert.NoError(t, err)
plugin := p.(*schemaHandler)
assert.Equal(t, "runtime data", plugin.fileFormat.(testFileFormat).validateSchemaRuntime.(string))
assert.Equal(t, "runtime data", plugin.formatRuntime.(string))
assert.IsType(t, &schemaHandler{}, p)
assert.Equal(t, "runtime data", p.(*schemaHandler).formatRuntime.(string))
}

func TestCreateHandler_CustomParseFuncs_Success(t *testing.T) {
Expand Down Expand Up @@ -226,15 +246,15 @@ func TestNewIngester_CustomFileFormat_Failure(t *testing.T) {
}

func TestNewIngester_CustomFileFormat_Success(t *testing.T) {
plugin := &schemaHandler{
handler := &schemaHandler{
ctx: &handlers.HandlerCtx{
CustomFuncs: customfuncs.BuiltinCustomFuncs,
},
fileFormat: testFileFormat{},
formatRuntime: "test runtime",
}
ctx := &transformctx.Ctx{InputName: "test-input"}
ip, err := plugin.NewIngester(ctx, strings.NewReader("test input"))
ip, err := handler.NewIngester(ctx, strings.NewReader("test input"))
assert.NoError(t, err)
g := ip.(*ingester)
assert.Equal(t, ctx, g.ctx)
Expand Down
5 changes: 4 additions & 1 deletion samples/omniv2/customfileformats/jsonlog/sample_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import (
"github.com/jf-tech/omniparser"
"github.com/jf-tech/omniparser/customfuncs"
omniv2 "github.com/jf-tech/omniparser/handlers/omni/v2"
omniv2fileformat "github.com/jf-tech/omniparser/handlers/omni/v2/fileformat"
"github.com/jf-tech/omniparser/samples/omniv2/customfileformats/jsonlog/jsonlogformat"
"github.com/jf-tech/omniparser/transformctx"
)
Expand Down Expand Up @@ -58,7 +59,9 @@ func TestSample(t *testing.T) {
CreateHandler: omniv2.CreateHandler, // Use the same omniv2 handler
HandlerParams: &omniv2.HandlerParams{
// But use our own FileFormat.
CustomFileFormat: jsonlogformat.NewJSONLogFileFormat(schemaFileBaseName),
CustomFileFormats: []omniv2fileformat.FileFormat{
jsonlogformat.NewJSONLogFileFormat(schemaFileBaseName),
},
},
CustomFuncs: customfuncs.CustomFuncs{
"normalize_severity": normalizeSeverity,
Expand Down