tox -edocs target is broken

[Stephen Finucane]

The 'docs' tox target currently fails due to dos line-endings that have snuck into notification samples. Output below.

docs runtests: commands[2] | bash -c ! find doc/ -type f -name *.json | xargs grep -U -n $'\r'
doc/notification_samples/instance-rebuild-error.json:1:{
doc/notification_samples/instance-rebuild-error.json:2: "priority": "ERROR",
doc/notification_samples/instance-rebuild-error.json:3: "payload": {
doc/notification_samples/instance-rebuild-error.json:4: "nova_object.name": "InstanceActionPayload",
doc/notification_samples/instance-rebuild-error.json:5: "nova_object.data": {
doc/notification_samples/instance-rebuild-error.json:6: "state": "active",
doc/notification_samples/instance-rebuild-error.json:7: "availability_zone": null,
doc/notification_samples/instance-rebuild-error.json:8: "kernel_id": "",
doc/notification_samples/instance-rebuild-error.json:9: "host_name": "some-server",
doc/notification_samples/instance-rebuild-error.json:10: "progress": 0,
doc/notification_samples/instance-rebuild-error.json:11: "task_state": "rebuilding",
doc/notification_samples/instance-rebuild-error.json:12: "deleted_at": null,
doc/notification_samples/instance-rebuild-error.json:13: "architecture": null,
doc/notification_samples/instance-rebuild-error.json:14: "ramdisk_id": "",
doc/notification_samples/instance-rebuild-error.json:15: "locked": false,
doc/notification_samples/instance-rebuild-error.json:16: "created_at": "2012-10-29T13:42:11Z",
doc/notification_samples/instance-rebuild-error.json:17: "host": "compute",
doc/notification_samples/instance-rebuild-error.json:18: "display_name": "some-server",
doc/notification_samples/instance-rebuild-error.json:19: "os_type": null,
doc/notification_samples/instance-rebuild-error.json:20: "metadata": {},
doc/notification_samples/instance-rebuild-error.json:21: "ip_addresses": [
doc/notification_samples/instance-rebuild-error.json:22: {
doc/notification_samples/instance-rebuild-error.json:23: "nova_object.name": "IpPayload",
doc/notification_samples/instance-rebuild-error.json:24: "nova_object.data": {
doc/notification_samples/instance-rebuild-error.json:25: "device_name": "tapce531f90-19",
doc/notification_samples/instance-rebuild-error.json:26: "port_uuid": "ce531f90-199f-48c0-816c-13e38010b442",
doc/notification_samples/instance-rebuild-error.json:27: "address": "192.168.1.3",
doc/notification_samples/instance-rebuild-error.json:28: "version": 4,
doc/notification_samples/instance-rebuild-error.json:29: "meta": {},
doc/notification_samples/instance-rebuild-error.json:30: "label": "private-network",
doc/notification_samples/instance-rebuild-error.json:31: "mac": "fa:16:3e:4c:2c:30"
doc/notification_samples/instance-rebuild-error.json:32: },
doc/notification_samples/instance-rebuild-error.json:33: "nova_object.version": "1.0",
doc/notification_samples/instance-rebuild-error.json:34: "nova_object.namespace": "nova"
doc/notification_samples/instance-rebuild-error.json:35: }
doc/notification_samples/instance-rebuild-error.json:36: ],
doc/notification_samples/instance-rebuild-error.json:37: "power_state": "running",
doc/notification_samples/instance-rebuild-error.json:38: "display_description": "some-server",
doc/notification_samples/instance-rebuild-error.json:39: "uuid": "5fafd989-4043-44b4-8acc-907e847f4b70",
doc/notification_samples/instance-rebuild-error.json:40: "flavor": {
doc/notification_samples/instance-rebuild-error.json:41: "nova_object.name": "FlavorPayload",
doc/notification_samples/instance-rebuild-error.json:42: "nova_object.data": {
doc/notification_samples/instance-rebuild-error.json:43: "disabled": false,
doc/notification_samples/instance-rebuild-error.json:44: "ephemeral_gb": 0,
doc/notification_samples/instance-rebuild-error.json:45: "extra_specs": {"hw:watchdog_action": "disabled"},
doc/notification_samples/instance-rebuild-error.json:46: "flavorid": "a22d5517-147c-4147-a0d1-e698df5cd4e3",
doc/notification_samples/instance-rebuild-error.json:47: "is_public": true,
doc/notification_samples/instance-rebuild-error.json:48: "memory_mb": 512,
doc/notification_samples/instance-rebuild-error.json:49: "name": "test_flavor",
doc/notification_samples/instance-rebuild-error.json:50: "projects": null,
doc/notification_samples/instance-rebuild-error.json:51: "root_gb": 1,
doc/notification_samples/instance-rebuild-error.json:52: "rxtx_factor": 1.0,
doc/notification_samples/instance-rebuild-error.json:53: "swap": 0,
doc/notification_samples/instance-rebuild-error.json:54: "vcpu_weight": 0,
doc/notification_samples/instance-rebuild-error.json:55: "vcpus": 1
doc/notification_samples/instance-rebuild-error.json:56: },
doc/notification_samples/instance-rebuild-error.json:57: "nova_object.version": "1.3",
doc/notification_samples/instance-rebuild-error.json:58: "nova_object.namespace": "nova"
doc/notification_samples/instance-rebuild-error.json:59: },
doc/notification_samples/instance-rebuild-error.json:60: "reservation_id": "r-pfiic52h",
doc/notification_samples/instance-rebuild-error.json:61: "terminated_at": null,
doc/notification_samples/instance-rebuild-error.json:62: "tenant_id": "6f70656e737461636b20342065766572",
doc/notification_samples/instance-rebuild-error.json:63: "node": "fake-mini",
doc/notification_samples/instance-rebuild-error.json:64: "launched_at": "2012-10-29T13:42:11Z",
doc/notification_samples/instance-rebuild-error.json:65: "user_id": "fake",
doc/notification_samples/instance-rebuild-error.json:66: "image_uuid": "a2459075-d96c-40d5-893e-577ff92e721c",
doc/notification_samples/instance-rebuild-error.json:67: "fault": {
doc/notification_samples/instance-rebuild-error.json:68: "nova_object.name": "ExceptionPayload",
doc/notification_samples/instance-rebuild-error.json:69: "nova_object.data": {
doc/notification_samples/instance-rebuild-error.json:70: "module_name": "nova.tests.functional.notification_sample_tests.test_instance",
doc/notification_samples/instance-rebuild-error.json:71: "exception_message": "Insufficient compute resources: fake-resource.",
doc/notification_samples/instance-rebuild-error.json:72: "function_name": "_compute_resources_unavailable",
doc/notification_samples/instance-rebuild-error.json:73: "exception": "ComputeResourcesUnavailable"
doc/notification_samples/instance-rebuild-error.json:74: },
doc/notification_samples/instance-rebuild-error.json:75: "nova_object.version": "1.0",
doc/notification_samples/instance-rebuild-error.json:76: "nova_object.namespace": "nova"
doc/notification_samples/instance-rebuild-error.json:77: }
doc/notification_samples/instance-rebuild-error.json:78: },
doc/notification_samples/instance-rebuild-error.json:79: "nova_object.version": "1.1",
doc/notification_samples/instance-rebuild-error.json:80: "nova_object.namespace": "nova"
doc/notification_samples/instance-rebuild-error.json:81: },
doc/notification_samples/instance-rebuild-error.json:82: "publisher_id": "nova-compute:compute",
doc/notification_samples/instance-rebuild-error.json:83: "event_type": "instance.rebuild.error"
doc/notification_samples/instance-rebuild-error.json:84:}
ERROR: InvocationError: "/usr/bin/bash -c ! find doc/ -type f -name *.json | xargs grep -U -n $'\\r'"

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/446040

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/446041

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/446040
Committed: https://git.openstack.org/cgit/openstack/nova/commit/?id=66d7ca90d8bd0495ea2000ac31783d94f9bffd03
Submitter: Jenkins
Branch: master

commit 66d7ca90d8bd0495ea2000ac31783d94f9bffd03
Author: Stephen Finucane <email address hidden>
Date: Wed Mar 15 15:59:01 2017 +0000

    trivial: Remove \r\n line endings from JSON sample

    These are invalid and are currently causing the docs target to fail.

    Change-Id: I484f5b1b4785ce7b44992ca59f993c618f3ce0c2
    Partial-Bug: #1673131

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/446041
Committed: https://git.openstack.org/cgit/openstack/nova/commit/?id=ac2a4abfca2885ae3bfb1f7cb40e57a488cba97d
Submitter: Jenkins
Branch: master

commit ac2a4abfca2885ae3bfb1f7cb40e57a488cba97d
Author: Stephen Finucane <email address hidden>
Date: Wed Mar 15 15:57:23 2017 +0000

    Duplicate JSON line ending check to pep8

    The docs job is not run in the gate, meaning invalid JSON files with
    \r\n line endings are able to sneak in. Duplicate the checks from the
    docs environment to the pep8 environment so that gate jobs run it.

    Note that pep8 is our general linting target and thus should include
    these kind of tests.

    Change-Id: Ie923902b04be79b9f66ba1841c60899a413f6439
    Closes-Bug: #1673131

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/nova 16.0.0.0b1 development milestone.