add quiet option #382

shmax · 2017-03-11T17:47:15Z

Fix for #380

Only emit output from CLI when there are errors or when --quiet is not specified.

Actually, I'm wondering if maybe we should just skip the --quiet option and simply not produce any output at all when validation passes. That's generally how other linux programs work from the command line.

@erayd @bighappyface @evilebottnawi

alexander-akait · 2017-03-11T17:49:50Z

and simply not produce any output at all when validation passes. That's generally how other linux programs work from the command line.

It's a great idea

erayd · 2017-03-11T17:51:40Z

Actually, I'm wondering if maybe we should just skip the --quiet option and simply not produce any output at all when validation passes. That's generally how other linux programs work from the command line.

I like this a lot, although if we go down this road, having a --verbose option probably makes sense.

shmax · 2017-03-11T18:06:38Z

I like this a lot, although if we go down this road, having a --verbose option probably makes sense.

Yeah, that's better. Let me flip it around...

erayd · 2017-03-11T18:36:06Z

bin/validate-json

-        echo "OK. The supplied JSON validates against the schema.\n";
+        if(isset($arOptions['--verbose'])) {
+            echo "OK. The supplied JSON validates against the schema.\n";
+        }
    } else {
        echo "JSON does not validate. Violations:\n";
        foreach ($validator->getErrors() as $error) {


Looking great :-).

While you're at it, can we also have a --quiet option that suppresses the error output?

Sure, but what would be the use case?

Use case is scripts or pipelines where you don't care about the error output (and don't want the clutter); you just want to validate. Lots of linux / unix scripts only care about the exit status being zero (OK) or nonzero (not OK), which this script complies with.

Oh, okay. Sounds good. Comin' up.

shmax · 2017-03-11T19:06:50Z

Added 'quiet' option, and moved all of the option parsing stuff to the top of the file.

erayd · 2017-03-11T19:13:00Z

bin/validate-json

-    echo $e->getMessage() . "\n";
+    output("Error loading JSON schema file\n");
+    output($urlSchema . "\n");
+    output($e->getMessage() . "\n");
    exit(2);
 }
 $refResolver = new JsonSchema\SchemaStorage($retriever, $resolver);
 $schema = $refResolver->resolveRef($urlSchema);

 if (isset($arOptions['--dump-schema'])) {


Explicit requests for output like this should override --quiet.

GitHub highlighted the wrong line - I'm referring to if (isset($arOptions['--dump-schema']))

erayd · 2017-03-11T19:13:33Z

bin/validate-json

@@ -198,21 +210,21 @@ try {
    $urlSchema = $resolver->resolve($pathSchema, $urlData);

    if (isset($arOptions['--dump-schema-url'])) {


Explicit requests for output like this should override --quiet

Not sure whether you're intending this one in a different commit to the --dump-schema one, or if you missed it - but in the past you've combined this kind of thing in a single commit, so adding a comment just in case.

Never mind, I see you just posted a commit for that at about the same time as my last comment!

erayd

LGTM - thanks for doing this :-).

shmax · 2017-03-11T19:34:57Z

My pleasure. Only 28 issues to go!

alexander-akait · 2017-03-15T15:50:43Z

/cc @erayd can merge?

erayd · 2017-03-15T17:14:35Z

@shmax Any chance you could change the base branch to 6.0.0? Or would you prefer to forward-port this one, rather than backporting to 5.2.0?

shmax · 2017-03-15T19:19:10Z

Any chance you could change the base branch to 6.0.0?

SGTM

erayd · 2017-03-15T19:21:50Z

Awesome - thanks :-)

* add quiet option * use verbose instead of quiet * add quiet option * always output dump-schema * always output dump-schema-url * fix typo and ws

* Add URI translation for retrieval & add local copies of spec schema * Add use line for InvalidArgumentException & adjust scope (#372) Fixes issue #371 * add quiet option (#382) * add quiet option * use verbose instead of quiet * add quiet option * always output dump-schema * always output dump-schema-url * fix typo and ws * [BUGFIX] Add provided schema under a dummy / internal URI (fixes #376) (#378) * Add provided schema under a dummy / internal URI (fixes #376) In order to resolve internal $ref references within a user-provided schema, SchemaStorage needs to know about the schema. As user-supplied schemas do not have an associated URI, use a dummy / internal one instead. * Remove dangling use * Change URI to class constant on SchemaStorage * Add option to disable validation of "format" constraint (#383) * Add more unit tests (#366) * Add test coverage for coercion API * Complete test coverage for SchemaStorage * Add test coverage for ObjectIterator * Add exception test for JsonPointer * MabeEnum\Enum appears to use singletons - add testing const * Don't check this line for coverage mbstring is on all test platforms, so this line will never be reached. * Add test for TypeConstraint::validateTypeNameWording() * Add test for exception on TypeConstraint::validateType() * PHPunit doesn't like an explanation with its @codeCoverageIgnore... * Add various tests for UriRetriever * Add tests for FileGetContents * Add tests for JsonSchema\Uri\Retrievers\Curl * Add missing bad-syntax test file * Restrict ignore to the exception line only * Fix exception scope * Allow the schema to be an associative array (#389) * Allow the schema to be an associative array Implements #388. * Use json_decode(json_encode()) for array -> object cast * Skip exception check on PHP versions < 5.5.0 * Skip test on HHVM, as it's happy to encode resources * Enable FILTER_FLAG_EMAIL_UNICODE for email format if present (#398) * Don't throw exceptions until after checking anyOf / oneOf (#394) Fixes #393 * Fix infinite recursion on some schemas when setting defaults (#359) (#365) * Don't try to fetch files that don't exist Throws an exception when the ref can't be resolved to a useful file URI, rather than waiting for something further down the line to fail after the fact. * Refactor defaults code to use LooseTypeCheck where appropriate * Test for not treating non-containers like arrays * Update comments * Rename variable for clarity * Add CHECK_MODE_ONLY_REQUIRED_DEFAULTS If CHECK_MODE_ONLY_REQUIRED_DEFAULTS is set, then only apply defaults if they are marked as required. * Workaround for $this scope issue on PHP-5.3 * Fix infinite recursion via $ref when applying defaults * Add missing second test for array case * Add test for setting a default value for null * Also fix infinite recursion via $ref for array defaults * Move nested closure into separate method * $parentSchema will always be set when $name is, so don't check it * Handle nulls properly - fixes issue #377 * Add option to also validate the schema (#357) * Remove stale files from #357 (obviated by #362) (#400) * Stop #386 sneaking in alongside another PR backport

* add quiet option * use verbose instead of quiet * add quiet option * always output dump-schema * always output dump-schema-url * fix typo and ws

add quiet option

7f5097a

use verbose instead of quiet

eee03bb

erayd approved these changes Mar 11, 2017

View reviewed changes

add quiet option

8173115

erayd requested changes Mar 11, 2017

View reviewed changes

shmax added 2 commits March 11, 2017 11:19

always output dump-schema

53a65e0

always output dump-schema-url

51865ab

erayd approved these changes Mar 11, 2017

View reviewed changes

fix typo and ws

aad0b75

erayd approved these changes Mar 11, 2017

View reviewed changes

shmax changed the base branch from master to 6.0.0-dev March 15, 2017 19:19

bighappyface approved these changes Mar 17, 2017

View reviewed changes

bighappyface merged commit d3f7740 into jsonrainbow:6.0.0-dev Mar 17, 2017

erayd pushed a commit to erayd/json-schema that referenced this pull request Mar 17, 2017

add quiet option (jsonrainbow#382)

92c6f4e

* add quiet option * use verbose instead of quiet * add quiet option * always output dump-schema * always output dump-schema-url * fix typo and ws

erayd mentioned this pull request Mar 17, 2017

Backports for 5.2.0 #368

Merged

erayd pushed a commit to erayd/json-schema that referenced this pull request Mar 17, 2017

add quiet option (jsonrainbow#382)

94d4530

* add quiet option * use verbose instead of quiet * add quiet option * always output dump-schema * always output dump-schema-url * fix typo and ws

erayd pushed a commit to erayd/json-schema that referenced this pull request Mar 22, 2017

add quiet option (jsonrainbow#382)

7d37a85

* add quiet option * use verbose instead of quiet * add quiet option * always output dump-schema * always output dump-schema-url * fix typo and ws

shmax deleted the add-quiet-option branch March 2, 2019 01:51

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add quiet option #382

add quiet option #382

shmax commented Mar 11, 2017

alexander-akait commented Mar 11, 2017

erayd commented Mar 11, 2017

shmax commented Mar 11, 2017

erayd Mar 11, 2017

shmax Mar 11, 2017

erayd Mar 11, 2017 •

edited

Loading

shmax Mar 11, 2017

shmax commented Mar 11, 2017

erayd Mar 11, 2017

erayd Mar 11, 2017

shmax Mar 11, 2017

erayd Mar 11, 2017

erayd Mar 11, 2017 •

edited

Loading

erayd Mar 11, 2017

erayd left a comment

shmax commented Mar 11, 2017

alexander-akait commented Mar 15, 2017

erayd commented Mar 15, 2017

shmax commented Mar 15, 2017

erayd commented Mar 15, 2017

		@@ -198,21 +210,21 @@ try {
		$urlSchema = $resolver->resolve($pathSchema, $urlData);

		if (isset($arOptions['--dump-schema-url'])) {

add quiet option #382

add quiet option #382

Conversation

shmax commented Mar 11, 2017

alexander-akait commented Mar 11, 2017

erayd commented Mar 11, 2017

shmax commented Mar 11, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

erayd Mar 11, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

shmax commented Mar 11, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

erayd Mar 11, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

erayd left a comment

Choose a reason for hiding this comment

shmax commented Mar 11, 2017

alexander-akait commented Mar 15, 2017

erayd commented Mar 15, 2017

shmax commented Mar 15, 2017

erayd commented Mar 15, 2017

erayd Mar 11, 2017 •

edited

Loading

erayd Mar 11, 2017 •

edited

Loading