USRealEstate
/
web-api-commander
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
web-api-commander/README.md

38 lines
1.7 KiB
Markdown
Raw Normal View History

Issue 37 Add Data Dictionary testing to the RESO Commmander (#41) * Added DD Spreadsheet, Command Line option, and parser * Initial check-in of DD generator and generated .feature files for 1.7 resources * Added file naming and header info to the generated files, regenerated Gluecode * Changed generator templates * Added support for additional DD resources and updated generator * Added new Commander build * Changed templates * Refactored generator and changed DD templates * Refactored WorksheetProcessor into base class * Added EDMX Generator * Added better EDMX generation * Intermediate check-in for EDMX processor * Added dependency injection of test containers, changed from Java8 Lambda test expressions to functions * Added skip logic and resource tags to generators * Generated new tests and improved skipped test messaging * Corrected Test Template * Finished first round of DD tests: field presence * Expanded field map to include all resources rather than just the one included in the Web API test * DD test generator intermediate check-in * EDMX Generator build enumerations generator * EDMX generator can generate valid EDMX files. See: /src/main/resources * Re-generated EDMX and BDD Tests from sanitized spreadsheet * Issue #30 - Convert Web API Server tests to Core, and remove Date Part comparisons * Updated DD BDD test format * Wrapped up test templates and generated new BDD acceptance tests * Cleaned up EDMX generation * Wrapped up first round of EDMX generation using Key (but not KeyNumeric). Metadata validation passes on generated file * Updated EDMX generator with Single and Multiple Enumerations * Updated reference XSLX, generated new EDMX and BDD Tests * Added updated BDD generators with improved tags and addedcomments with descriptions in the generated EDMX * Added generation of comments for both Standard Fields and Standard Enumerations, and also added a StandardEnumeration class and builder * Updated reference EDMX and BDD test generators to use Collections of enumerations rather than multi-select enum types. Added newly generated EDMX and BDD tests * Added the ability to generate Standard Relationships into NavigationProperty definitions * Added updated reference EDMX document * Updated Standard Relationships and re-generated EDMX and Open API definitions * Removed Partner Property Definitions and extra info logging * Added Data Dictionary tests for Collections, TODO: README and non-collection based enumerations * Issue #37 - added support for multiple enumerations that use IsFlags=true * Issue #37 - added better reporting * Issue #37 - Allow Edm.Double in addition to Edm.Decimal as per Cert group 10/1/2020 call * Issue #37 - added Gradle task to generate minimal 'pretty' reports. * Issue #37 - added updated .JAR and updated build.gradle * Issue #37 - Added additional error information to test results * Issue #37 - Added BDD generation for Lookups and stubs for testing. Prepended 'sample' to the RESOScript templates * Issue #37 - committing new BDD tests * Issue #37 - Added enumeration MAY and MUST support * Issue #37 - Added field-level synonyms checking and fixed invalid synonyms in DD sheet * Issue #37 - added test to check that closed enumerations only have standard values * Issue #37 - added better logging, including more info about standard vs. non-standard enumerations * Issue #37 - further improvement of OData type error messages * Issue #37 - Added fuzzy matching of enumerations using Levenshtein distance * Issue #37 - Improved Edit Distance behavior, added IgnoredItem and ignored.json, and updated Vha, Usda, and Fha with VHA, USDA, and FHA * Issue #37 - Added better error messages, --strict=true for strict testing mode, and metadata-report.json to output results to aggregation server * Issue #37 - Added auto-generating output directory as well as a generateCertificationReports_DD_1_7 task that takes -DpathToJsonResults from the cert task and creates a pretty report * Issue #37 - Added better error message formatting and handling, and help messages for gradle tasks * Issue #37 - updated README and fixed some of the existing Web API Commander JAR tasks, as well as improved the all-in-one generateCertificationReport task * Issue #37 - Cleaned up some items in the README and message output * Update README.md
2021-01-06 02:47:04 -05:00
Updated configurations and removed Cucumber Reports (#81) - Removed all Cucumber Reporting steps and code, updated README to reflect the removal. - Moved all output files to `build/certification` within the project directory and put them under results, reports, and cucumberJson (for downstream Cucumber Reporting plugins, such as that in Jenkins). - Addded GradleDocker config file so containers may be built that specifically run Docker tasks. - Added GitHub Workflow to add a GradleDocker image to the GitHub Docker registry on commit to main. - Reorganized and updated README. - removed additional --strict flags in Cucumber JVM (since they're deprecated). - Fixed issue with synonym checker not running in when `-Dstrict=true` is passed. - Separated payloads and IDX backing glue code.
2021-07-19 10:47:12 -04:00
# RESO Commander
initial check-in of prototype * working API commander * adding XSLT for EDMX -> OAI * moved sample metadata files to their own directory. * improvements to readability and handling * working serializer * build producing working JAR in /out/artifacts/... * added saveRawGetRequest and fixed readEntities * added support for filter expressions in readEntities, which was also re-written * adding more correct command line handling * adding README and ready for PR * added further exception handling to validateMetadata
2019-03-22 15:54:06 -04:00
Update README.md (#13)
2020-04-01 18:56:49 -04:00
[![CodeFactor](https://www.codefactor.io/repository/github/resostandards/web-api-commander/badge)](https://www.codefactor.io/repository/github/resostandards/web-api-commander) ![Java CI with Gradle](https://github.com/RESOStandards/web-api-commander/workflows/Java%20CI%20with%20Gradle/badge.svg?branch=master)
initial check-in of prototype * working API commander * adding XSLT for EDMX -> OAI * moved sample metadata files to their own directory. * improvements to readability and handling * working serializer * build producing working JAR in /out/artifacts/... * added saveRawGetRequest and fixed readEntities * added support for filter expressions in readEntities, which was also re-written * adding more correct command line handling * adding README and ready for PR * added further exception handling to validateMetadata
2019-03-22 15:54:06 -04:00
Updated configurations and removed Cucumber Reports (#81) - Removed all Cucumber Reporting steps and code, updated README to reflect the removal. - Moved all output files to `build/certification` within the project directory and put them under results, reports, and cucumberJson (for downstream Cucumber Reporting plugins, such as that in Jenkins). - Addded GradleDocker config file so containers may be built that specifically run Docker tasks. - Added GitHub Workflow to add a GradleDocker image to the GitHub Docker registry on commit to main. - Reorganized and updated README. - removed additional --strict flags in Cucumber JVM (since they're deprecated). - Fixed issue with synonym checker not running in when `-Dstrict=true` is passed. - Separated payloads and IDX backing glue code.
2021-07-19 10:47:12 -04:00
The RESO Commander is an OData client Java library and command-line client,
as well as an automated RESO Certification testing tool.
Update README.md Minor tweaks to README and added TOC.
2020-02-21 03:45:56 -05:00
Updated configurations and removed Cucumber Reports (#81) - Removed all Cucumber Reporting steps and code, updated README to reflect the removal. - Moved all output files to `build/certification` within the project directory and put them under results, reports, and cucumberJson (for downstream Cucumber Reporting plugins, such as that in Jenkins). - Addded GradleDocker config file so containers may be built that specifically run Docker tasks. - Added GitHub Workflow to add a GradleDocker image to the GitHub Docker registry on commit to main. - Reorganized and updated README. - removed additional --strict flags in Cucumber JVM (since they're deprecated). - Fixed issue with synonym checker not running in when `-Dstrict=true` is passed. - Separated payloads and IDX backing glue code.
2021-07-19 10:47:12 -04:00
# Getting Started
To begin using the RESO Commander, choose one of the following topics:
Issue 37 Add Data Dictionary testing to the RESO Commmander (#41) * Added DD Spreadsheet, Command Line option, and parser * Initial check-in of DD generator and generated .feature files for 1.7 resources * Added file naming and header info to the generated files, regenerated Gluecode * Changed generator templates * Added support for additional DD resources and updated generator * Added new Commander build * Changed templates * Refactored generator and changed DD templates * Refactored WorksheetProcessor into base class * Added EDMX Generator * Added better EDMX generation * Intermediate check-in for EDMX processor * Added dependency injection of test containers, changed from Java8 Lambda test expressions to functions * Added skip logic and resource tags to generators * Generated new tests and improved skipped test messaging * Corrected Test Template * Finished first round of DD tests: field presence * Expanded field map to include all resources rather than just the one included in the Web API test * DD test generator intermediate check-in * EDMX Generator build enumerations generator * EDMX generator can generate valid EDMX files. See: /src/main/resources * Re-generated EDMX and BDD Tests from sanitized spreadsheet * Issue #30 - Convert Web API Server tests to Core, and remove Date Part comparisons * Updated DD BDD test format * Wrapped up test templates and generated new BDD acceptance tests * Cleaned up EDMX generation * Wrapped up first round of EDMX generation using Key (but not KeyNumeric). Metadata validation passes on generated file * Updated EDMX generator with Single and Multiple Enumerations * Updated reference XSLX, generated new EDMX and BDD Tests * Added updated BDD generators with improved tags and addedcomments with descriptions in the generated EDMX * Added generation of comments for both Standard Fields and Standard Enumerations, and also added a StandardEnumeration class and builder * Updated reference EDMX and BDD test generators to use Collections of enumerations rather than multi-select enum types. Added newly generated EDMX and BDD tests * Added the ability to generate Standard Relationships into NavigationProperty definitions * Added updated reference EDMX document * Updated Standard Relationships and re-generated EDMX and Open API definitions * Removed Partner Property Definitions and extra info logging * Added Data Dictionary tests for Collections, TODO: README and non-collection based enumerations * Issue #37 - added support for multiple enumerations that use IsFlags=true * Issue #37 - added better reporting * Issue #37 - Allow Edm.Double in addition to Edm.Decimal as per Cert group 10/1/2020 call * Issue #37 - added Gradle task to generate minimal 'pretty' reports. * Issue #37 - added updated .JAR and updated build.gradle * Issue #37 - Added additional error information to test results * Issue #37 - Added BDD generation for Lookups and stubs for testing. Prepended 'sample' to the RESOScript templates * Issue #37 - committing new BDD tests * Issue #37 - Added enumeration MAY and MUST support * Issue #37 - Added field-level synonyms checking and fixed invalid synonyms in DD sheet * Issue #37 - added test to check that closed enumerations only have standard values * Issue #37 - added better logging, including more info about standard vs. non-standard enumerations * Issue #37 - further improvement of OData type error messages * Issue #37 - Added fuzzy matching of enumerations using Levenshtein distance * Issue #37 - Improved Edit Distance behavior, added IgnoredItem and ignored.json, and updated Vha, Usda, and Fha with VHA, USDA, and FHA * Issue #37 - Added better error messages, --strict=true for strict testing mode, and metadata-report.json to output results to aggregation server * Issue #37 - Added auto-generating output directory as well as a generateCertificationReports_DD_1_7 task that takes -DpathToJsonResults from the cert task and creates a pretty report * Issue #37 - Added better error message formatting and handling, and help messages for gradle tasks * Issue #37 - updated README and fixed some of the existing Web API Commander JAR tasks, as well as improved the all-in-one generateCertificationReport task * Issue #37 - Cleaned up some items in the README and message output * Update README.md
2021-01-06 02:47:04 -05:00
Updated configurations and removed Cucumber Reports (#81) - Removed all Cucumber Reporting steps and code, updated README to reflect the removal. - Moved all output files to `build/certification` within the project directory and put them under results, reports, and cucumberJson (for downstream Cucumber Reporting plugins, such as that in Jenkins). - Addded GradleDocker config file so containers may be built that specifically run Docker tasks. - Added GitHub Workflow to add a GradleDocker image to the GitHub Docker registry on commit to main. - Reorganized and updated README. - removed additional --strict flags in Cucumber JVM (since they're deprecated). - Fixed issue with synonym checker not running in when `-Dstrict=true` is passed. - Separated payloads and IDX backing glue code.
2021-07-19 10:47:12 -04:00
## [RESO Certification](/doc/Certification.md)
One of the Commander's primary uses is as an automated testing tool. This section
explains how to run the following tests:
initial check-in of prototype * working API commander * adding XSLT for EDMX -> OAI * moved sample metadata files to their own directory. * improvements to readability and handling * working serializer * build producing working JAR in /out/artifacts/... * added saveRawGetRequest and fixed readEntities * added support for filter expressions in readEntities, which was also re-written * adding more correct command line handling * adding README and ready for PR * added further exception handling to validateMetadata
2019-03-22 15:54:06 -04:00
Updated configurations and removed Cucumber Reports (#81) - Removed all Cucumber Reporting steps and code, updated README to reflect the removal. - Moved all output files to `build/certification` within the project directory and put them under results, reports, and cucumberJson (for downstream Cucumber Reporting plugins, such as that in Jenkins). - Addded GradleDocker config file so containers may be built that specifically run Docker tasks. - Added GitHub Workflow to add a GradleDocker image to the GitHub Docker registry on commit to main. - Reorganized and updated README. - removed additional --strict flags in Cucumber JVM (since they're deprecated). - Fixed issue with synonym checker not running in when `-Dstrict=true` is passed. - Separated payloads and IDX backing glue code.
2021-07-19 10:47:12 -04:00
* Data Dictionary 1.7
* Data Dictionary Availability Report
* IDX Payload 1.7
Support for Field and Lookup Resources (#95) * Issue #85: bump Web API Core version to 2.0.0 * Added strict flag=true by default for metadata and availability checks. JSON Schema WIP. * Issue #88: added batch test runner as well as improved Web API Messages * Issue #91: added field availability metrics * Issue #91: availability and field count rollups * Issue #91: calculate lookup value availabilities * Issue #91: lookup rollups * Issue #91: added lookup availability * Issue #91: resource availability calculations * Issue #91: adding comments and addressing null values * Issue #91: cleanup lookup iterations * Issue #88: added XMLMetadataToJSONSchemaSerializer * Issue #93: Added Field and Lookup resource * Issue #93: Updated README
2021-12-13 00:22:42 -05:00
* Web API Core 2.0.0
Update README.md
2020-03-23 21:44:01 -04:00
Updated configurations and removed Cucumber Reports (#81) - Removed all Cucumber Reporting steps and code, updated README to reflect the removal. - Moved all output files to `build/certification` within the project directory and put them under results, reports, and cucumberJson (for downstream Cucumber Reporting plugins, such as that in Jenkins). - Addded GradleDocker config file so containers may be built that specifically run Docker tasks. - Added GitHub Workflow to add a GradleDocker image to the GitHub Docker registry on commit to main. - Reorganized and updated README. - removed additional --strict flags in Cucumber JVM (since they're deprecated). - Fixed issue with synonym checker not running in when `-Dstrict=true` is passed. - Separated payloads and IDX backing glue code.
2021-07-19 10:47:12 -04:00
## [Command-Line OData Web API Tools](/doc/CLI.md)
The RESO Commander contains command line tools for working with OData Web APIs.
This section covers how to validate metadata, make requests, and generate sample requests for testing.
Update README.md
2020-03-23 21:44:01 -04:00
Updated configurations and removed Cucumber Reports (#81) - Removed all Cucumber Reporting steps and code, updated README to reflect the removal. - Moved all output files to `build/certification` within the project directory and put them under results, reports, and cucumberJson (for downstream Cucumber Reporting plugins, such as that in Jenkins). - Addded GradleDocker config file so containers may be built that specifically run Docker tasks. - Added GitHub Workflow to add a GradleDocker image to the GitHub Docker registry on commit to main. - Reorganized and updated README. - removed additional --strict flags in Cucumber JVM (since they're deprecated). - Fixed issue with synonym checker not running in when `-Dstrict=true` is passed. - Separated payloads and IDX backing glue code.
2021-07-19 10:47:12 -04:00
## [Web API Client Library](/doc/ODataClient.md)
The RESO Commander offers a convenient wrapper around the Apache Olingo Java client for OData,
with added support for OAuth2 Bearer Tokens and Client Credentials.
Update README.md
2020-03-23 21:44:01 -04:00
Updated configurations and removed Cucumber Reports (#81) - Removed all Cucumber Reporting steps and code, updated README to reflect the removal. - Moved all output files to `build/certification` within the project directory and put them under results, reports, and cucumberJson (for downstream Cucumber Reporting plugins, such as that in Jenkins). - Addded GradleDocker config file so containers may be built that specifically run Docker tasks. - Added GitHub Workflow to add a GradleDocker image to the GitHub Docker registry on commit to main. - Reorganized and updated README. - removed additional --strict flags in Cucumber JVM (since they're deprecated). - Fixed issue with synonym checker not running in when `-Dstrict=true` is passed. - Separated payloads and IDX backing glue code.
2021-07-19 10:47:12 -04:00
The client library can be used to fetch and validate metadata, fetch data, and perform other
OData client tasks.
Update README.md
2020-03-23 21:44:01 -04:00
Updated configurations and removed Cucumber Reports (#81) - Removed all Cucumber Reporting steps and code, updated README to reflect the removal. - Moved all output files to `build/certification` within the project directory and put them under results, reports, and cucumberJson (for downstream Cucumber Reporting plugins, such as that in Jenkins). - Addded GradleDocker config file so containers may be built that specifically run Docker tasks. - Added GitHub Workflow to add a GradleDocker image to the GitHub Docker registry on commit to main. - Reorganized and updated README. - removed additional --strict flags in Cucumber JVM (since they're deprecated). - Fixed issue with synonym checker not running in when `-Dstrict=true` is passed. - Separated payloads and IDX backing glue code.
2021-07-19 10:47:12 -04:00
## [Docker](/doc/Docker.md)
For those who prefer Docker, both the Command Line and Automated Testing Tools can be
run in a Docker container.
initial check-in of prototype * working API commander * adding XSLT for EDMX -> OAI * moved sample metadata files to their own directory. * improvements to readability and handling * working serializer * build producing working JAR in /out/artifacts/... * added saveRawGetRequest and fixed readEntities * added support for filter expressions in readEntities, which was also re-written * adding more correct command line handling * adding README and ready for PR * added further exception handling to validateMetadata
2019-03-22 15:54:06 -04:00
Updated configurations and removed Cucumber Reports (#81) - Removed all Cucumber Reporting steps and code, updated README to reflect the removal. - Moved all output files to `build/certification` within the project directory and put them under results, reports, and cucumberJson (for downstream Cucumber Reporting plugins, such as that in Jenkins). - Addded GradleDocker config file so containers may be built that specifically run Docker tasks. - Added GitHub Workflow to add a GradleDocker image to the GitHub Docker registry on commit to main. - Reorganized and updated README. - removed additional --strict flags in Cucumber JVM (since they're deprecated). - Fixed issue with synonym checker not running in when `-Dstrict=true` is passed. - Separated payloads and IDX backing glue code.
2021-07-19 10:47:12 -04:00
## [Codegen](/doc/Codegen.md)
The RESO Commander may also be used to generate reference XML Metadata, DDL, database seeds,
automated acceptance tests, reference server models, and to convert XML Metadata to Open API 3 format.