Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alumbra/alumbra.generators
GraphQL Generators for Clojure's test.check
https://github.com/alumbra/alumbra.generators
alumbra graphql property-based-testing
Last synced: about 2 months ago
JSON representation
GraphQL Generators for Clojure's test.check
- Host: GitHub
- URL: https://github.com/alumbra/alumbra.generators
- Owner: alumbra
- License: mit
- Created: 2016-10-21T19:49:11.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2017-01-07T14:14:23.000Z (almost 8 years ago)
- Last Synced: 2024-08-19T21:03:52.814Z (4 months ago)
- Topics: alumbra, graphql, property-based-testing
- Language: Clojure
- Homepage: https://alumbra.github.io/alumbra.generators/
- Size: 106 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# alumbra.generators
A collection of [test.check][tc] generators for [GraphQL][ql] queries.
[](https://travis-ci.org/alumbra/alumbra.generators)
[](https://clojars.org/alumbra/generators)
[tc]: https://github.com/clojure/test.check
[ql]: http://graphql.org/
There are two types of queries that can be generated: random ones that show
syntactic correctness but might be utter nonsense, and those based on an
analyzed schema, being both syntactically and semantically correct.
## Usage
__[Documentation](https://alumbra.github.io/alumbra.generators/)__
### Valid Data
Given a GraphQL schema ([parsed][alumbra-parser] and
[analyzed][alumbra-analyzer]), a generator for valid GraphQL operations can
be built:
```clojure
(require '[alumbra.generators :as gen])
(def gen-operation
(gen/operation
(-> "type Person { name: String!, pets: [Pet!] }
type Pet { name: String!, meows: Boolean }
type QueryRoot { person(name: String!): Person }
schema { query: QueryRoot }"
(alumbra.analyzer/analyze-schema alumbra.parser/parse-schema))))
```
This is a function that takes the operation type and, optionally, operation name
and produces a string value representing our desired operation, conforming to
the above schema.
```clojure
(rand-nth
(clojure.test.check.generators/sample (gen-operation :query "Q")))
;; => "query Q {
;; __schema {
;; queryType { inputFields { defaultValue, description }, ... }
;; },
;; person(name: \"Mu90ChZ1ht\") { name }
;; }"
```
As you can see, the implicitly given introspection fields will be accessed
just as well.
[alumbra-parser]: https://github.com/alumbra/alumbra.parser
[alumbra-analyzer]: https://github.com/alumbra/alumbra.analyzer
### Random Data
#### Query Documents
This generates a GraphQL document as described in the [GraphQL
specification][ql-spec].
```clojure
(clojure.test.check.generators/sample (gen/raw-document) 1)
;; => ("mutation X($h: [T]! = 0.8e-57753886, $Q: [K]! = 0.1693) { ...")
```
[ql-spec]: https://facebook.github.io/graphql/
#### Schema Documents
This generates a GraphQL IDL document. There is, as of the writing of this
README, no complete specification on this, so it is based on the [Schemas and
Types](http://graphql.org/learn/schema/) guide, as well as the current state of
[this PR](https://github.com/facebook/graphql/pull/90).
```clojure
(clojure.test.check.generators/sample (gen/raw-schema) 1)
;; => ("schema {query: O, mutation: B}\ninterface G {D(c: [I]): [O]}\nenum F {O}")
```
## License
```
MIT License
Copyright (c) 2016 Yannick Scherer
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```