File size: 7,647 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
//                           _       _
// __      _____  __ ___   ___  __ _| |_ ___
// \ \ /\ / / _ \/ _` \ \ / / |/ _` | __/ _ \
//  \ V  V /  __/ (_| |\ V /| | (_| | ||  __/
//   \_/\_/ \___|\__,_| \_/ |_|\__,_|\__\___|
//
//  Copyright © 2016 - 2024 Weaviate B.V. All rights reserved.
//
//  CONTACT: [email protected]
//

package local

import (
	"fmt"
	"runtime/debug"
	"testing"

	logrus "github.com/sirupsen/logrus/hooks/test"
	"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/require"
	"github.com/tailor-inc/graphql"
	"github.com/weaviate/weaviate/entities/models"
	"github.com/weaviate/weaviate/entities/schema"
	"github.com/weaviate/weaviate/usecases/config"
	"github.com/weaviate/weaviate/usecases/modules"
)

// These tests are component tests for the local package including all its
// subpackages, such as get, getmeta, etc.. However, they only assert that the
// graphql tree can be built under certain circumstances. This helps us to
// catch errors on edge cases like empty schemas, classes with empty
// properties, empty peer lists, peers with empty schemas, etc. However, we
// don't get any guarantee of whether the individual queries resolve
// correctly. For those cases we have unit tests in die individual subpackages
// (i.e. get, getmeta, aggregate, etc.).  Additionally we have (a few) e2e
// tests.

func TestBuild_GraphQLNetwork(t *testing.T) {
	tests := testCases{
		// This tests asserts that an action-only schema doesn't lead to errors.
		testCase{
			name: "with only objects locally",
			localSchema: schema.Schema{
				Objects: &models.Schema{
					Classes: []*models.Class{
						{
							Class: "BestLocalAction",
							Properties: []*models.Property{
								{
									DataType:     schema.DataTypeText.PropString(),
									Name:         "myStringProp",
									Tokenization: models.PropertyTokenizationWhitespace,
								},
							},
						},
					},
				},
			},
		},

		// This tests asserts that a things-only schema doesn't lead to errors.
		testCase{
			name: "with only objects locally",
			localSchema: schema.Schema{
				Objects: &models.Schema{
					Classes: []*models.Class{
						{
							Class: "BestLocalThing",
							Properties: []*models.Property{
								{
									DataType:     schema.DataTypeText.PropString(),
									Name:         "myStringProp",
									Tokenization: models.PropertyTokenizationWhitespace,
								},
							},
						},
					},
				},
			},
		},

		// This tests asserts that a class without any properties doesn't lead to
		// errors.
		testCase{
			name: "with things without properties locally",
			localSchema: schema.Schema{
				Objects: &models.Schema{
					Classes: []*models.Class{
						{
							Class:      "BestLocalThing",
							Properties: []*models.Property{},
						},
					},
				},
			},
		},

		testCase{
			name:        "without any peers",
			localSchema: validSchema(),
		},
	}

	tests.AssertNoError(t)
}

func TestBuild_RefProps(t *testing.T) {
	t.Run("expected error logs", func(t *testing.T) {
		tests := testCases{
			{
				name: "build class with nonexistent ref prop",
				localSchema: schema.Schema{
					Objects: &models.Schema{
						Classes: []*models.Class{
							{
								Class: "ThisClassExists",
								Properties: []*models.Property{
									{
										DataType: []string{"ThisClassDoesNotExist"},
										Name:     "ofNonexistentClass",
									},
								},
							},
						},
					},
				},
			},
		}

		expectedLogMsg := "ignoring ref prop \"ofNonexistentClass\" on class \"ThisClassExists\", " +
			"because it contains reference to nonexistent class [\"ThisClassDoesNotExist\"]"

		tests.AssertErrorLogs(t, expectedLogMsg)
	})

	t.Run("expected success", func(t *testing.T) {
		tests := testCases{
			{
				name: "build class with existing non-circular ref prop",
				localSchema: schema.Schema{
					Objects: &models.Schema{
						Classes: []*models.Class{
							{
								Class: "ThisClassExists",
								Properties: []*models.Property{
									{
										DataType: []string{"ThisClassAlsoExists"},
										Name:     "ofExistingClass",
									},
								},
							},
							{
								Class: "ThisClassAlsoExists",
								Properties: []*models.Property{
									{
										DataType:     schema.DataTypeText.PropString(),
										Name:         "stringProp",
										Tokenization: models.PropertyTokenizationWhitespace,
									},
								},
							},
						},
					},
				},
			},
			{
				name: "build class with existing circular ref prop",
				localSchema: schema.Schema{
					Objects: &models.Schema{
						Classes: []*models.Class{
							{
								Class: "ThisClassExists",
								Properties: []*models.Property{
									{
										DataType: []string{"ThisClassAlsoExists"},
										Name:     "ofExistingClass",
									},
								},
							},
							{
								Class: "ThisClassAlsoExists",
								Properties: []*models.Property{
									{
										DataType: []string{"ThisClassExists"},
										Name:     "ofExistingClass",
									},
								},
							},
						},
					},
				},
			},
		}

		tests.AssertNoError(t)
	})
}

type testCase struct {
	name        string
	localSchema schema.Schema
}

type testCases []testCase

func (tests testCases) AssertNoError(t *testing.T) {
	for _, test := range tests {
		t.Run(test.name, func(t *testing.T) {
			modules := modules.NewProvider()
			localSchema, err := Build(&test.localSchema, nil, config.Config{}, modules)
			require.Nil(t, err, test.name)

			schemaObject := graphql.ObjectConfig{
				Name:        "WeaviateObj",
				Description: "Location of the root query",
				Fields:      localSchema,
			}

			func() {
				defer func() {
					if r := recover(); r != nil {
						err = fmt.Errorf("%v at %s", r, debug.Stack())
					}
				}()

				_, err = graphql.NewSchema(graphql.SchemaConfig{
					Query: graphql.NewObject(schemaObject),
				})
			}()

			assert.Nil(t, err, test.name)
		})
	}
}

// AssertErrorLogs still expects the test to pass without errors,
// but does expect the Build logger to contain errors messages
// from the GQL schema rebuilding thunk
func (tests testCases) AssertErrorLogs(t *testing.T, expectedMsg string) {
	for _, test := range tests {
		t.Run(test.name, func(t *testing.T) {
			modules := modules.NewProvider()
			logger, logsHook := logrus.NewNullLogger()
			localSchema, err := Build(&test.localSchema, logger, config.Config{}, modules)
			require.Nil(t, err, test.name)

			schemaObject := graphql.ObjectConfig{
				Name:        "WeaviateObj",
				Description: "Location of the root query",
				Fields:      localSchema,
			}

			func() {
				defer func() {
					if r := recover(); r != nil {
						err = fmt.Errorf("%v at %s", r, debug.Stack())
					}
				}()

				_, err = graphql.NewSchema(graphql.SchemaConfig{
					Query: graphql.NewObject(schemaObject),
				})
			}()

			last := logsHook.LastEntry()
			assert.Contains(t, last.Message, expectedMsg)
			assert.Nil(t, err)
		})
	}
}

func validSchema() schema.Schema {
	return schema.Schema{
		Objects: &models.Schema{
			Classes: []*models.Class{
				{
					Class: "BestLocalThing",
					Properties: []*models.Property{
						{
							DataType:     schema.DataTypeText.PropString(),
							Name:         "myStringProp",
							Tokenization: models.PropertyTokenizationWhitespace,
						},
					},
				},
			},
		},
	}
}