feat: add SchemaService and FillEntityDefaults utility #119

GGabriele · 2022-01-24T14:39:09Z

Mirroring what's been previously done for Plugins,
this adds GetFullSchema to Routes, Upstreams, Targets and Services.
This also adds utils function to fill core entities with
defaults comings from their schema.

hbagdi · 2022-01-24T18:05:00Z

Let's do this a bit differently.
Let's create a SchemaService with a function to pull a schema for any entity. Get(entityname string) something like. That is much more concise and meets the goal.

GGabriele · 2022-01-24T18:50:27Z

@hbagdi good point.

Since I removed the GetFullSchema from each entity service, I also moved all the tests under kong/utils_test.go. Let me know what you think.

kong/schema_service.go

kong/schema_service_test.go

kong/utils.go

hbagdi

Nice patch!

kong/utils.go

hbagdi · 2022-01-25T22:36:32Z

kong/utils_test.go

+		expected *Route
+	}{
+		{
+			name: "name paths",


Suggested change

name: "name paths",

name: "fills defaults for all fields except paths, leaves name as is",

Descriptive tests, please.

kong/utils_test.go

codecov-commenter · 2022-01-26T17:27:20Z

Codecov Report

Merging #119 (0dd30c6) into main (e965de2) will increase coverage by 0.07%.
The diff coverage is 66.66%.

@@            Coverage Diff             @@
##             main     #119      +/-   ##
==========================================
+ Coverage   44.46%   44.54%   +0.07%     
==========================================
  Files          42       43       +1     
  Lines        3805     3929     +124     
==========================================
+ Hits         1692     1750      +58     
- Misses       1793     1851      +58     
- Partials      320      328       +8

Flag	Coverage Δ
2.0.5	`39.37% <66.66%> (+0.24%)`	⬆️
2.1.4	`39.19% <66.66%> (+0.24%)`	⬆️
2.2.2	`39.19% <66.66%> (+0.24%)`	⬆️
2.3.3	`39.19% <66.66%> (+0.24%)`	⬆️
2.4.0	`39.19% <66.66%> (+0.24%)`	⬆️
community	`39.37% <66.66%> (+0.24%)`	⬆️
enterprise	`44.23% <66.66%> (+0.08%)`	⬆️
enterprise-1.5.0.11	`44.23% <66.66%> (+0.08%)`	⬆️
enterprise-2.1.4.6	`43.14% <66.66%> (+0.11%)`	⬆️
enterprise-2.2.1.3	`43.14% <66.66%> (+0.11%)`	⬆️
enterprise-2.3.3.2	`43.46% <66.66%> (+0.43%)`	⬆️
enterprise-2.3.3.4	`43.46% <66.66%> (?)`
enterprise-2.4.1.3	`43.46% <66.66%> (?)`
enterprise-2.5.1.2	`43.46% <66.66%> (?)`
enterprise-2.6.0.2	`43.46% <66.66%> (?)`
integration	`44.54% <66.66%> (+0.07%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
kong/schema_service.go	`45.45% <45.45%> (ø)`
kong/utils.go	`80.09% <67.16%> (-5.91%)`	⬇️
kong/client.go	`59.33% <100.00%> (+0.39%)`	⬆️
kong/plugin_service.go	`56.79% <100.00%> (ø)`
kong/types.go	`9.09% <0.00%> (+2.04%)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e965de2...0dd30c6. Read the comment docs.

hbagdi · 2022-01-26T17:49:36Z

@rainest Can I get a review from you on this one as well?

Mirroring what's been previously done for Plugins, this adds GetFullSchema to Routes, Upstreams, Targets and Services. This also adds utils function to fill core entities with defaults comings from their schema.

hbagdi

Let's move ahead on this one. If there are more issues, @GGabriele please take care of resolving with subsequent PRs.

GGabriele requested a review from a team as a code owner January 24, 2022 14:39

GGabriele force-pushed the core_entities_defaults branch from df63973 to c0e7b4b Compare January 24, 2022 14:42

hbagdi requested a review from rainest January 24, 2022 20:12