Spaces:
Running
Running
File size: 8,572 Bytes
b110593 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 |
// _ _
// __ _____ __ ___ ___ __ _| |_ ___
// \ \ /\ / / _ \/ _` \ \ / / |/ _` | __/ _ \
// \ V V / __/ (_| |\ V /| | (_| | || __/
// \_/\_/ \___|\__,_| \_/ |_|\__,_|\__\___|
//
// Copyright © 2016 - 2024 Weaviate B.V. All rights reserved.
//
// CONTACT: [email protected]
//
package modules
import (
"context"
"testing"
"github.com/pkg/errors"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"github.com/weaviate/weaviate/entities/models"
"github.com/weaviate/weaviate/entities/modulecapabilities"
"github.com/weaviate/weaviate/entities/moduletools"
"github.com/weaviate/weaviate/entities/schema"
)
func TestSetClassDefaults(t *testing.T) {
t.Run("no modules", func(t *testing.T) {
class := &models.Class{
Class: "Foo",
Vectorizer: "none",
}
p := NewProvider()
p.SetClassDefaults(class)
assert.Equal(t, &models.Class{Class: "Foo", Vectorizer: "none"}, class,
"the class is not changed")
})
t.Run("module is set, but does not have config capability", func(t *testing.T) {
class := &models.Class{
Class: "Foo",
Vectorizer: "my-module",
}
p := NewProvider()
p.Register(&dummyText2VecModuleNoCapabilities{name: "my-module"})
p.SetClassDefaults(class)
assert.Equal(t, &models.Class{Class: "Foo", Vectorizer: "my-module"}, class,
"the class is not changed")
})
t.Run("without user-provided values", func(t *testing.T) {
class := &models.Class{
Class: "Foo",
Properties: []*models.Property{{
Name: "Foo",
DataType: schema.DataTypeText.PropString(),
Tokenization: models.PropertyTokenizationWhitespace,
}},
Vectorizer: "my-module",
}
expected := &models.Class{
Class: "Foo",
ModuleConfig: map[string]interface{}{
"my-module": map[string]interface{}{
"per-class-prop-1": "some default value",
"per-class-prop-2": "some default value",
},
},
Properties: []*models.Property{{
Name: "Foo",
DataType: schema.DataTypeText.PropString(),
Tokenization: models.PropertyTokenizationWhitespace,
ModuleConfig: map[string]interface{}{
"my-module": map[string]interface{}{
"per-prop-1": "prop default value",
"per-prop-2": "prop default value",
},
},
}},
Vectorizer: "my-module",
}
p := NewProvider()
p.Register(&dummyModuleClassConfigurator{
dummyText2VecModuleNoCapabilities: dummyText2VecModuleNoCapabilities{
name: "my-module",
},
})
p.SetClassDefaults(class)
assert.Equal(t, expected, class,
"the defaults were set from config")
})
t.Run("with some user-provided values", func(t *testing.T) {
class := &models.Class{
Class: "Foo",
ModuleConfig: map[string]interface{}{
"my-module": map[string]interface{}{
"per-class-prop-1": "overwritten by user",
},
},
Properties: []*models.Property{{
Name: "Foo",
DataType: schema.DataTypeText.PropString(),
Tokenization: models.PropertyTokenizationWhitespace,
ModuleConfig: map[string]interface{}{
"my-module": map[string]interface{}{
"per-prop-1": "prop overwritten by user",
},
},
}},
Vectorizer: "my-module",
}
expected := &models.Class{
Class: "Foo",
ModuleConfig: map[string]interface{}{
"my-module": map[string]interface{}{
"per-class-prop-1": "overwritten by user",
"per-class-prop-2": "some default value",
},
},
Properties: []*models.Property{{
Name: "Foo",
DataType: schema.DataTypeText.PropString(),
Tokenization: models.PropertyTokenizationWhitespace,
ModuleConfig: map[string]interface{}{
"my-module": map[string]interface{}{
"per-prop-1": "prop overwritten by user",
"per-prop-2": "prop default value",
},
},
}},
Vectorizer: "my-module",
}
p := NewProvider()
p.Register(&dummyModuleClassConfigurator{
dummyText2VecModuleNoCapabilities: dummyText2VecModuleNoCapabilities{
name: "my-module",
},
})
p.SetClassDefaults(class)
assert.Equal(t, expected, class,
"the defaults were set from config")
})
}
func TestValidateClass(t *testing.T) {
ctx := context.Background()
t.Run("when class has no vectorizer set, it does not check", func(t *testing.T) {
class := &models.Class{
Class: "Foo",
Properties: []*models.Property{{
Name: "Foo",
DataType: schema.DataTypeText.PropString(),
Tokenization: models.PropertyTokenizationWhitespace,
}},
Vectorizer: "none",
}
p := NewProvider()
p.Register(&dummyModuleClassConfigurator{
validateError: errors.Errorf("if I was used, you'd fail"),
dummyText2VecModuleNoCapabilities: dummyText2VecModuleNoCapabilities{
name: "my-module",
},
})
p.SetClassDefaults(class)
assert.Nil(t, p.ValidateClass(ctx, class))
})
t.Run("when vectorizer does not have capability, it skips validation",
func(t *testing.T) {
class := &models.Class{
Class: "Foo",
Properties: []*models.Property{{
Name: "Foo",
DataType: schema.DataTypeText.PropString(),
Tokenization: models.PropertyTokenizationWhitespace,
}},
Vectorizer: "my-module",
}
p := NewProvider()
p.Register(&dummyText2VecModuleNoCapabilities{
name: "my-module",
})
p.SetClassDefaults(class)
assert.Nil(t, p.ValidateClass(ctx, class))
})
t.Run("the module validates if capable and configured", func(t *testing.T) {
class := &models.Class{
Class: "Foo",
Properties: []*models.Property{{
Name: "Foo",
DataType: schema.DataTypeText.PropString(),
Tokenization: models.PropertyTokenizationWhitespace,
}},
Vectorizer: "my-module",
}
p := NewProvider()
p.Register(&dummyModuleClassConfigurator{
validateError: errors.Errorf("no can do!"),
dummyText2VecModuleNoCapabilities: dummyText2VecModuleNoCapabilities{
name: "my-module",
},
})
p.SetClassDefaults(class)
err := p.ValidateClass(ctx, class)
require.NotNil(t, err)
assert.Equal(t, "module 'my-module': no can do!", err.Error())
})
}
func TestSetSinglePropertyDefaults(t *testing.T) {
class := &models.Class{
Class: "Foo",
ModuleConfig: map[string]interface{}{
"my-module": map[string]interface{}{
"per-class-prop-1": "overwritten by user",
},
},
Properties: []*models.Property{{
Name: "Foo",
DataType: schema.DataTypeText.PropString(),
Tokenization: models.PropertyTokenizationWhitespace,
ModuleConfig: map[string]interface{}{
"my-module": map[string]interface{}{
"per-prop-1": "prop overwritten by user",
},
},
}},
Vectorizer: "my-module",
}
prop := &models.Property{
DataType: []string{"boolean"},
ModuleConfig: map[string]interface{}{
"my-module": map[string]interface{}{
"per-prop-1": "overwritten by user",
},
},
Name: "newProp",
}
expected := &models.Property{
DataType: []string{"boolean"},
ModuleConfig: map[string]interface{}{
"my-module": map[string]interface{}{
"per-prop-1": "overwritten by user",
"per-prop-2": "prop default value",
},
},
Name: "newProp",
}
p := NewProvider()
p.Register(&dummyModuleClassConfigurator{
dummyText2VecModuleNoCapabilities: dummyText2VecModuleNoCapabilities{
name: "my-module",
},
})
p.SetSinglePropertyDefaults(class, prop)
assert.Equal(t, expected, prop,
"user specified module config is used, for rest the default value is used")
}
type dummyModuleClassConfigurator struct {
dummyText2VecModuleNoCapabilities
validateError error
}
func (d *dummyModuleClassConfigurator) ClassConfigDefaults() map[string]interface{} {
return map[string]interface{}{
"per-class-prop-1": "some default value",
"per-class-prop-2": "some default value",
}
}
func (d *dummyModuleClassConfigurator) PropertyConfigDefaults(
dt *schema.DataType,
) map[string]interface{} {
return map[string]interface{}{
"per-prop-1": "prop default value",
"per-prop-2": "prop default value",
}
}
func (d *dummyModuleClassConfigurator) ValidateClass(ctx context.Context,
class *models.Class, cfg moduletools.ClassConfig,
) error {
return d.validateError
}
var _ = modulecapabilities.ClassConfigurator(
&dummyModuleClassConfigurator{})
|