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

Jump to bottom

Reporting/overview system for collection/process metadata merging issues #76

Closed
soxofaan opened this issue Sep 27, 2022 · 5 comments
Closed

Reporting/overview system for collection/process metadata merging issues #76

soxofaan opened this issue Sep 27, 2022 · 5 comments
Assignees
@JeroenVerstraelen
Labels
API evolution (SAP01) federation design

Comments

@soxofaan
Copy link
Member

follow up of #4 (merging of process metadata) and #5 (merging of collection metadata):

It turns out that there can be quite some issues when merging metadata, of varying degrees of importance/impact.
It would be good if we have some kind of system to get an overview or report issues
@soxofaan
Copy link
Member Author

soxofaan commented Sep 27, 2022 •
edited
Loading

still needs a bit of brainstorm to make more concrete, but some things to consider:

  • allow this to run as kind of integration tests (e.g. critical merge issues have to be resolved before deploying)
  • allow to run continuously as cron and report (e.g. daily health check)
  • allow other parties/back-ends to run this against a dev build for example
  • keep it simple as cli tool (which reporting format then?), or make it a web view (with auth?)

soxofaan added a commit that referenced this issue Sep 27, 2022
@soxofaan
Issue #76 extract collection merge logic for easier reuse
f043fbe
JeroenVerstraelen added a commit that referenced this issue Oct 10, 2022
@JeroenVerstraelen
issue #76 add models for metadata validation
3b9a376
JeroenVerstraelen added a commit that referenced this issue Oct 10, 2022
@JeroenVerstraelen
issue #76 document report function
d83ccad
JeroenVerstraelen added a commit that referenced this issue Oct 10, 2022
@JeroenVerstraelen
issue #76 add summary validation and merging
bdb858e
JeroenVerstraelen added a commit that referenced this issue Oct 10, 2022
@JeroenVerstraelen
issue #76 add extent validation and merging
721edcd
JeroenVerstraelen added a commit that referenced this issue Oct 10, 2022
@JeroenVerstraelen
issue #76 add cube:dimensions validation and merging
434e69b
JeroenVerstraelen added a commit that referenced this issue Oct 10, 2022
@JeroenVerstraelen
issue #76 adjust merging logs
8392320
JeroenVerstraelen added a commit that referenced this issue Oct 10, 2022
@JeroenVerstraelen
issue #76 add merging utils
31026c5
JeroenVerstraelen added a commit that referenced this issue Oct 10, 2022
@JeroenVerstraelen
issue #76 add cli validation tool
61e7188
@JeroenVerstraelen JeroenVerstraelen linked a pull request Oct 10, 2022 that will close this issue
Issue76 metadata merge report #77
Closed
JeroenVerstraelen added a commit that referenced this issue Oct 12, 2022
@JeroenVerstraelen
issue #76 move cli validation script
68462b4
JeroenVerstraelen added a commit that referenced this issue Oct 12, 2022
@JeroenVerstraelen
issue #76 add ValidationReporter class
8af692a
JeroenVerstraelen added a commit that referenced this issue Oct 12, 2022
@JeroenVerstraelen
issue #76 rename concat utility function
d62d4fd
JeroenVerstraelen added a commit that referenced this issue Oct 12, 2022
@JeroenVerstraelen
issue #76 add return type to merge_collection_metadata
1a0e8a7
JeroenVerstraelen added a commit that referenced this issue Oct 12, 2022
@JeroenVerstraelen
issue #76 add README to metadata directory
b4fed14
JeroenVerstraelen added a commit that referenced this issue Oct 12, 2022
@JeroenVerstraelen
issue #76 add attr package to setup.py
631cb62
JeroenVerstraelen added a commit that referenced this issue Oct 12, 2022
@JeroenVerstraelen
issue #76 fix reporting of unexpected types in merge_dict_values
69c1811
JeroenVerstraelen added a commit that referenced this issue Oct 12, 2022
@JeroenVerstraelen
issue #76 replace merge_dict_values with merge_lists_skip_duplicates
a546cb8
JeroenVerstraelen added a commit that referenced this issue Oct 12, 2022
@JeroenVerstraelen
issue #76 add __init__.py to models directory
ebbf053
JeroenVerstraelen added a commit that referenced this issue Oct 12, 2022
@JeroenVerstraelen
issue #76 update test_get_collection_metadata_merging_summaries
56fcfdb
JeroenVerstraelen added a commit that referenced this issue Oct 12, 2022
@JeroenVerstraelen
issue #76 reformat validator
c46a3eb
JeroenVerstraelen added a commit that referenced this issue Oct 12, 2022
@JeroenVerstraelen
issue #76 add reporter class
7b7b134
JeroenVerstraelen added a commit that referenced this issue Oct 14, 2022
@JeroenVerstraelen
issue #76 add compare_get_collection_by_id
c1816a9
JeroenVerstraelen added a commit that referenced this issue Oct 14, 2022
@JeroenVerstraelen
issue #76 switch isFull and report parameters
22f93bc
JeroenVerstraelen added a commit that referenced this issue Oct 14, 2022
@JeroenVerstraelen
issue #76 reformat merging.py
133a647
JeroenVerstraelen added a commit that referenced this issue Oct 14, 2022
@JeroenVerstraelen
issue #76 add merge_process_metadata
3e1ff08
JeroenVerstraelen added a commit that referenced this issue Oct 14, 2022
@JeroenVerstraelen
issue #76 add merge_process_metadata to get_process_registry
1857a54
JeroenVerstraelen added a commit that referenced this issue Oct 17, 2022
@JeroenVerstraelen
issue #76 add documentation for is_full parameter
48e69ae
@soxofaan
Copy link
Member Author

#77 has been merged now

@soxofaan
Copy link
Member Author

soxofaan commented Nov 10, 2022 •
edited by JeroenVerstraelen
Loading

With #77 being merged the big chunk of work is done. Some additional minor follow-up TODOs:

  • process metadata merging:
    • merge "deprecated"
    • merge "experimental"
    • merge "examples"
    • merge "links"
    • ignore "description" when comparing "returns" field
    • report missing parameter "description" (which is required) instead of falling back on "name"
  • collection metadata merging: check TODO comments in code
  • general
    • MarkDownReporter: drop distinction between warning/critical, or handle it more generically
    • define common interface for reporter classes (instead of disconnected MarkDownReporter and LoggerReporter
    • validator.py: add cli option to select check for collections only, processes only or both

soxofaan added a commit that referenced this issue Nov 10, 2022
@soxofaan
Issue #76 finetune markdown reporting of metadata issues
ccc25c3
soxofaan added a commit that referenced this issue Nov 10, 2022
@soxofaan
Issue #76 add cli option to select checks to run
0c6fab9
soxofaan added a commit that referenced this issue Nov 10, 2022
@soxofaan
Issue #76/#77 remove report level for now
c30abc4 
Level added more output overhead than real value at the moment
soxofaan added a commit that referenced this issue Nov 10, 2022
@soxofaan
Issue #76 improve markdown report of collections metadata issues
7f6b161
soxofaan added a commit that referenced this issue Nov 10, 2022
@soxofaan
Issue #76 fixup tests
25a324c
@soxofaan soxofaan mentioned this issue Nov 15, 2022
Open
@soxofaan
Copy link
Member Author

some more follow up issues:

JeroenVerstraelen added a commit that referenced this issue Nov 24, 2022
@JeroenVerstraelen
issue #76 define common interface for reporter classes
651a557
JeroenVerstraelen added a commit that referenced this issue Nov 24, 2022
@JeroenVerstraelen
issue #76 add rules for top level process merging
ebf7b24
JeroenVerstraelen added a commit that referenced this issue Nov 24, 2022
@JeroenVerstraelen
issue #76 ignore description when comparing returns field
9680cf0
JeroenVerstraelen added a commit that referenced this issue Nov 24, 2022
@JeroenVerstraelen
issue #76 report missing parameter description
8bd9142
JeroenVerstraelen added a commit that referenced this issue Nov 24, 2022
@JeroenVerstraelen
issue #76 adjust TestAggregatorProcessing and TestProcessing
c48d3ad
soxofaan added a commit that referenced this issue Nov 24, 2022
@soxofaan
fixup! issue #76 add rules for top level process merging
d323710
soxofaan added a commit that referenced this issue Nov 24, 2022
@soxofaan
fixup! issue #76 ignore description when comparing returns field
93489c1
soxofaan added a commit that referenced this issue Nov 24, 2022
@soxofaan
fixup! issue #76 report missing parameter description
fd6a3d7
@soxofaan soxofaan mentioned this issue Nov 24, 2022
Closed
@soxofaan
Copy link
Member Author

most follow up TODO's are done or moved to separate tickets.
I think we can close this #76 now.

thanks!

JeroenVerstraelen added a commit that referenced this issue Nov 29, 2022
@JeroenVerstraelen
issue #76 ensure collection_ids is a union across backends
e03fa23
JeroenVerstraelen added a commit that referenced this issue Nov 29, 2022
@JeroenVerstraelen
issue #76 ensure validator calls /collections at max once per backend
cb3a608
JeroenVerstraelen added a commit that referenced this issue Nov 29, 2022
@JeroenVerstraelen
issue #76 check for collections with empty string as id
e546141
JeroenVerstraelen added a commit that referenced this issue Nov 29, 2022
@JeroenVerstraelen
issue #76 check for invalid collections in /collections/collection_id
a6f2986
JeroenVerstraelen added a commit that referenced this issue Nov 29, 2022
@JeroenVerstraelen
issue #76 check if metadata id matches url id for collections
24f0941
@soxofaan soxofaan mentioned this issue Mar 31, 2023
Closed
@JohanKJSchreurs JohanKJSchreurs mentioned this issue Apr 11, 2023
Closed
19 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@JeroenVerstraelen JeroenVerstraelen

Labels
API evolution (SAP01) federation design
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Issue76 metadata merge report Open-EO/openeo-aggregator
2 participants
@soxofaan @JeroenVerstraelen