Some tests use assertEqual(observed, expected) , the argument order is wrong

[Clint Byrum]

The test cases will produce a confusing error message if the tests ever fail, so this is worth fixing.

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/64415
Committed: https://git.openstack.org/cgit/openstack/heat/commit/?id=240fec9eef800a53aec890ce9ba14b4d07f136d5
Submitter: Jenkins
Branch: master

commit 240fec9eef800a53aec890ce9ba14b4d07f136d5
Author: Pavlo Shchelokovskyy <email address hidden>
Date: Mon Dec 30 11:15:54 2013 +0200

    Fix order of arguments in assertEqual (patch 2/2)

    Some tests used incorrect order assertEqual(observed, expected).

    The correct order expected by testtools is
    assertEqual(expected, observed).

    This patch includes the other half of the files touched by these changes
    (starting from test_n* plus contrib code) to ease the review.

    Change-Id: I870386871581980abd796304dd91be0c662cb73e
    Partial-Bug: #1259292

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/61457
Committed: https://git.openstack.org/cgit/openstack/heat/commit/?id=499b7cccac96e134941dc1e6cd84afe41302fce5
Submitter: Jenkins
Branch: master

commit 499b7cccac96e134941dc1e6cd84afe41302fce5
Author: Pavlo Shchelokovskyy <email address hidden>
Date: Wed Dec 11 17:15:54 2013 +0200

    Fix order of arguments in assertEqual (patch 1/2)

    Some tests used incorrect order assertEqual(observed, expected).

    The correct order expected by testtools is
    assertEqual(expected, observed).

    This patch includes roughly half of the files touched by these changes
    (up to and including test_m* sans contrib code) to ease the review.

    Partial-Bug: #1259292

    Change-Id: I44bff827c7c50726d48aa649b7685712a233ee62

[Andrew Lazarev (alazarev)]

Could you point on doc that says that correct order of parameters is "expected, observed"? This is true for java junit. I was trying to find the same doc for testtools, but didn't success. Moreover official doc for python unittest (http://docs.python.org/2/library/unittest.html) says the opposite (yes, it is not testtools, but anyway).

[Steve Baker (steve-stevebaker)]

Look at the message that testtools builds for assertEquals fails.

[Kiyohiro Adachi (adachi)]

In 'assertEqual(expected, observed)', the string length of the sum of the results of repr(expected) and repr(observed) is greater than 70, then, MismatchError message is changed. Depending on the length of repr(observed), this condition is satisfied.

https://github.com/testing-cabal/testtools/blob/master/testtools/matchers/_basic.py#L77

[OpenStack Infra (hudson-openstack)]

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

[John Griffith (john-griffith)]

I don't see much value in this and honestly it seems rather silly to go through the effort. It happens that testtools does in fact use the ordering you prefer in their examples, however many other frameworks document using the exact opposite. In reality I don't see what it really matters or what the benefit is.

I don't speak for other projects but from Cinder's perspective this is not something I would want to see proposed for this stage of the release. If you want to go through and change this when Juno opens up and propose for Cinder at that time I suppose that's fine, but right now I'd rather people didn't spend time reviewing changes like this.

[OpenStack Infra (hudson-openstack)]

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

[Clint Byrum (clint-fewbar)]

Excerpts from John Griffith's message of 2014-02-25 23:47:08 UTC:
> I don't see much value in this and honestly it seems rather silly to go
> through the effort. It happens that testtools does in fact use the
> ordering you prefer in their examples, however many other frameworks
> document using the exact opposite. In reality I don't see what it
> really matters or what the benefit is.
>
> I don't speak for other projects but from Cinder's perspective this is
> not something I would want to see proposed for this stage of the
> release. If you want to go through and change this when Juno opens up
> and propose for Cinder at that time I suppose that's fine, but right now
> I'd rather people didn't spend time reviewing changes like this.
>

Hi John. The trouble happens when the tests fail, and it tells you the
opposite of reality. This isn't about the examples, it is about the text
of the failure report.

Unit tests are meant to help debug situations where a developer has
misunderstood complex inner workings of things. So if we also tell
them that we observed what they expect in the test, and expect what was
observed and what was also wrong, we are just decreasing the value of
the unit tests.

I agree that early in dev cycles is a better time for low priority issues,
and this is a low priority, but it is not a low value.

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

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

[Ildiko Vancsa (ildiko-vancsa)]

Hi,

This bug has a duplication: https://bugs.launchpad.net/ceilometer/+bug/1277104. There are ongoing activities for both bug reports, some of them are overlapping (Ceilometer and Cinder). It would be good to check these activities and synchronize them.

Best Regards,
Ildiko

[OpenStack Infra (hudson-openstack)]

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

[Ildiko Vancsa (ildiko-vancsa)]

Patch for python-ceilometerclient: https://review.openstack.org/#/c/81154/3

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/82498
Committed: https://git.openstack.org/cgit/openstack/python-heatclient/commit/?id=e07e9d936665d4c7e58edc30e2746544ce4fa784
Submitter: Jenkins
Branch: master

commit e07e9d936665d4c7e58edc30e2746544ce4fa784
Author: Pavlo Shchelokovskyy <email address hidden>
Date: Mon Mar 24 14:58:47 2014 +0200

    Use correct order of arguments to assertEqual

    The correct order of arguments to assertEqual that is expected by
    testtools is (expected, observed).

    This patch fixes the inverted usage of arguments in some places
    that have cropped up since the last fix of this bug.

    Change-Id: Ifbc5da5cba0c8dcdf5b9c9eb6e6bfb1b1c2b49b0
    Closes-Bug: #1259292

[Sandeep Kedari (sandy86299)]

Working on the following bug

[gordon chung (chungg)]

marking invalid for ceilometer, will track via https://bugs.launchpad.net/ceilometer/+bug/1277104

[OpenStack Infra (hudson-openstack)]

Change abandoned by Duncan Thomas (<email address hidden>) on branch: master
Review: https://review.openstack.org/75357
Reason: Abandoning change: No update for more than 14 days

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/76453
Committed: https://git.openstack.org/cgit/openstack/python-cinderclient/commit/?id=f3ec0814971112068e933e343ef7ab8986f438c3
Submitter: Jenkins
Branch: master

commit f3ec0814971112068e933e343ef7ab8986f438c3
Author: KIYOHIRO ADACHI <email address hidden>
Date: Wed Feb 26 15:59:14 2014 +0900

    Fix order of arguments in assertEqual

    Some tests used incorrect order assertEqual(observed, expected).

    The correct order expected by testtools is...

        def assertEqual(self, expected, observed, message=''):
            """Assert that 'expected' is equal to 'observed'.

            :param expected: The expected value.
            :param observed: The observed value.
            :param message: An optional message to include in the error.
            """

    The string length of the sum of the results of repr(expected) and
    repr(observed) is greater than 70, then, MismatchError message is
    changed, as below.

      Ex.:
            raise mismatch_error
        MismatchError: !=:
        reference = '_123456789_123456789_bar'
        actual = '_123456789_123456789_123456789_123456789_123456789'

    Change-Id: Id02ddfb2ca03df7f432cff67a7bed182cccc4924
    Closes-Bug: #1259292

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/77562
Committed: https://git.openstack.org/cgit/openstack/horizon/commit/?id=c7d5371b47079a07f32137e82422ded41d501a9f
Submitter: Jenkins
Branch: master

commit c7d5371b47079a07f32137e82422ded41d501a9f
Author: ChenZheng <email address hidden>
Date: Mon Mar 3 18:48:46 2014 +0800

    Fix order of arguments in assertEqual

    Some tests used incorrect order assertEqual(observed, expected).

    The correct order expected by testtools is
    assertEqual(expected, observed).

    Change-Id: Iabf6e55146412b57b6a6544f312f9510f762566a
    Partial-Bug: #1259292

[Qiming Teng (tengqim)]

Qiming is screening the heat code base to make sure Heat is not affected by this.

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/138369
Committed: https://git.openstack.org/cgit/openstack/heat/commit/?id=3d2b7facdab23181b876b2272f587a2400caadc1
Submitter: Jenkins
Branch: master

commit 3d2b7facdab23181b876b2272f587a2400caadc1
Author: tengqm <email address hidden>
Date: Tue Dec 2 21:44:12 2014 +0800

    Make all assertEqual() calls conform to convention

    It is a convention to have assertEqual() assertions invoked with
    'expected value' before 'actual value', or else the debug output may
    become very confusing. This patch fixes about 100 violations in current
    test cases where about 3580 assertEqual calls are made.

    Closes-Bug: 1259292
    Change-Id: I2e0474d9821716baf35a3bbb2952c63a84749dd3

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/145133
Committed: https://git.openstack.org/cgit/openstack/cinder/commit/?id=f743605fa3dae8f57003e50fa50c864a89e8c3b2
Submitter: Jenkins
Branch: master

commit f743605fa3dae8f57003e50fa50c864a89e8c3b2
Author: Bharat Kumar Kobagana <email address hidden>
Date: Tue Jan 6 11:14:18 2015 +0530

    Fix argument order in assertEqual: tests/test_glusterfs.py

    The assertEqual in cinder/tests/test_glusterfs.py is using
    incorrect argument order (observed, expected), which causes the
    error message about mismatch to be reversed if the test case fails.
    Change it to (expected, observed).

    Change-Id: Idcd88de9c5e8a096f0ef473e92bff17e6be16814
    Partial-Bug: #1259292

[OpenStack Infra (hudson-openstack)]

Change abandoned by Mike Perez (<email address hidden>) on branch: master
Review: https://review.openstack.org/145162
Reason: inactive for a month

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/145166
Committed: https://git.openstack.org/cgit/openstack/cinder/commit/?id=d813f3f005be6043e615c57f3f7b0a3e0b4d30b3
Submitter: Jenkins
Branch: master

commit d813f3f005be6043e615c57f3f7b0a3e0b4d30b3
Author: Bharat Kumar Kobagana <email address hidden>
Date: Tue Jan 6 14:08:05 2015 +0530

    Fix argument order in assertEqual: tests/test_nfs.py

    The assertEqual in cinder/tests/test_nfs.py is using
    incorrect argument order (observed, expected), which causes the
    error message about mismatch to be reversed if the test case fails.
    Change it to (expected, observed).

    Change-Id: I7fec2e5df91369c3cae2adef3189e8bd86fe4480
    Partial-Bug: #1259292

[OpenStack Infra (hudson-openstack)]

Change abandoned by Bharat Kumar Kobagana (<email address hidden>) on branch: master
Review: https://review.openstack.org/145173
Reason: As this patch is not necessary as a separate patch.

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/165271
Committed: https://git.openstack.org/cgit/openstack/sahara/commit/?id=cb480679a1f75f558be414f85143c11b2406a31b
Submitter: Jenkins
Branch: master

commit cb480679a1f75f558be414f85143c11b2406a31b
Author: Jacob Bin Wang <email address hidden>
Date: Wed Mar 18 09:29:40 2015 +0800

    Fix order of arguments in assertEqual - Part1

    Some tests used incorrect order assertEqual(observed, expected).
    The correct order expected by testtools is:
        def assertEqual(self, expected, observed, message='')
    Changed to use the right order. Also if the order is wrong and
    expected value is None, change it to assertIsNone instead.

    It requires big changes and some tests change frequently.
    So I would do it in series of small CR.
    This part contains all changes except tests of plugins and service.

    Partial-Bug: #1259292

    Change-Id: Iefbb5f4b9efca35f7a2298f9f7f5b9de73fc260f

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/solum 5.0.0 release.

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/python-cinderclient 1.9.0 release.

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/networking-sfc 2.0.0 release.

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: stable/liberty
Review: https://review.openstack.org/367442

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/networking-sfc 2.0.0 release.

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/361025
Committed: https://git.openstack.org/cgit/openstack/networking-sfc/commit/?id=f7d95a4045c3407063f7906eeb3dda3f4ac1b58c
Submitter: Jenkins
Branch: master

commit f7d95a4045c3407063f7906eeb3dda3f4ac1b58c
Author: SongmingYan <email address hidden>
Date: Fri Aug 26 04:42:38 2016 -0400

    Fix order of arguments in assertEqual

    Some tests used incorrect order assertEqual(observed, expected).
    The correct order expected by testtools
    is assertEqual(expected, observed).

    Closes bug: #1259292

    Change-Id: If670c54ee7f6dae2911c1165619dcad4dca6c06d

[OpenStack Infra (hudson-openstack)]

Change abandoned by Tuan Luong-Anh (<email address hidden>) on branch: master
Review: https://review.openstack.org/356283

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/338179
Committed: https://git.openstack.org/cgit/openstack/networking-calico/commit/?id=8599fe0af907bc5aeff29c994bafdf87ef558b71
Submitter: Jenkins
Branch: master

commit 8599fe0af907bc5aeff29c994bafdf87ef558b71
Author: SongmingYan <email address hidden>
Date: Wed Jul 6 06:48:10 2016 -0400

    Fix order of arguments in assertEqual

    Some tests used incorrect order assertEqual(observed, expected).
    The correct order expected by testtools is
    assertEqual(expected, observed).

    Closes bug: #1259292

    Change-Id: I39aa28bea07a3cc6dcab472d526b7d3436d5270d

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/networking-ovn 1.0.0.0rc1 release candidate.

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/python-cinderclient 1.9.0 release.

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/378699
Committed: https://git.openstack.org/cgit/openstack/barbican/commit/?id=403e440f8504d2716b154043565032e3d145b63e
Submitter: Jenkins
Branch: master

commit 403e440f8504d2716b154043565032e3d145b63e
Author: Jiong Liu <email address hidden>
Date: Wed Sep 28 23:19:16 2016 +0800

    Fix order of arguments in assertEqual

    The correct order expected by testtools is assertEqual(expected, observed).

    Change-Id: I93eaab96f170e72cfcbc763f384fd9358842ef69
    Partial-Bug: #1259292

[Steve Martinelli (stevemar)]

Fixed in pycadf: https://review.openstack.org/#/c/338781/

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/338717
Committed: https://git.openstack.org/cgit/openstack/python-barbicanclient/commit/?id=86d91e4e4e39ed0b4b65e393ca49172fd555ddd0
Submitter: Jenkins
Branch: master

commit 86d91e4e4e39ed0b4b65e393ca49172fd555ddd0
Author: hongzhezheng <email address hidden>
Date: Thu Jul 7 16:23:31 2016 +0800

    Fix argument order for assertEqual to (expected, observed)

    assertEqual expects that the arguments provided to it should be
    (expected, observed). If a particluar order is kept as a convention,
    then it helps to provide a cleaner message to the developer if Unit
    Tests fail. The following patch fixes this issue.

    Change-Id: I5209e5889cfe62c66dc675c00e3ccaf22410f637
    Partial-Bug: #1259292

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/378684
Committed: https://git.openstack.org/cgit/openstack/python-barbicanclient/commit/?id=bd97bedb3f9b0bddcf3556acc4cd01ab35c7e960
Submitter: Jenkins
Branch: master

commit bd97bedb3f9b0bddcf3556acc4cd01ab35c7e960
Author: Jiong Liu <email address hidden>
Date: Wed Sep 28 22:59:54 2016 +0800

    Fix order of arguments in assertEqual

    The correct order expected by testtools is assertEqual(expected, observed).

    Change-Id: I8457af6e15a9000dd6c54ad8199331e75bd3c7fd
    Partial-Bug: #1259292

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/networking-ovn 1.0.0.0rc1 release candidate.

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/python-cinderclient 1.9.0 release.

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/344085
Committed: https://git.openstack.org/cgit/openstack/networking-l2gw/commit/?id=0ded69ae72c8395a1324505e516288801ba369ab
Submitter: Jenkins
Branch: master

commit 0ded69ae72c8395a1324505e516288801ba369ab
Author: LiuYong <email address hidden>
Date: Wed Jul 20 00:05:29 2016 +0800

    Remove execute permission which is added by mistake in l2gw

    Some files in networking-l2gw/tests/unit
    were given execute permission by mistake
    in Change-Id: I29020058671348e0734906a71ac3ae0798172a23.
    This proposal want to remove the error permission.

    Change-Id: I7e6466f8e9a0886e293df3f229d03a49b6fc92cc
    Related-Id: I29020058671348e0734906a71ac3ae0798172a23
    Partial-Bug: #1259292

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/python-cloudkittyclient 0.5.0 release.

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/python-barbicanclient 4.1.0 release.

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/python-cinderclient 1.9.0 release.

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/networking-sfc 3.0.0 release.

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/python-barbicanclient 4.1.0 release.

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/python-cinderclient 1.9.0 release.

[OpenStack Infra (hudson-openstack)]

Change abandoned by Sharat Sharma (<email address hidden>) on branch: master
Review: https://review.openstack.org/356483

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack-dev/pbr 2.0.0 release.

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

Change abandoned by sudhir agarwal (<email address hidden>) on branch: master
Review: https://review.openstack.org/443698

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

Change abandoned by Matt Riedemann (<email address hidden>) on branch: master
Review: https://review.openstack.org/450148

[OpenStack Infra (hudson-openstack)]

Change abandoned by sudhir agarwal (<email address hidden>) on branch: master
Review: https://review.openstack.org/444582

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/444582
Committed: https://git.openstack.org/cgit/openstack/rally/commit/?id=0aec3cc166590ea4bc95d4a0dacd7f79dfa84735
Submitter: Jenkins
Branch: master

commit 0aec3cc166590ea4bc95d4a0dacd7f79dfa84735
Author: sudhir_agarwal <email address hidden>
Date: Fri Jun 30 16:43:39 2017 +0530

    Fixed order of arguments in assertEqual

    Some tests used incorrect order of arguments in
    assertEqual(observed, expected). The correct order expected
    by testtool is assertEqual(expected, observed).

    Partial-Bug: #1259292

    Change-Id: I944b72f743a21d0908d17485c25aeb0e7ee70cba

[OpenStack Infra (hudson-openstack)]

Change abandoned by sudhir agarwal (<email address hidden>) on branch: master
Review: https://review.openstack.org/489232

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/564482
Committed: https://git.openstack.org/cgit/openstack/freezer-api/commit/?id=67e5953c1c66a27dea021abb86029b2470114fb4
Submitter: Zuul
Branch: master

commit 67e5953c1c66a27dea021abb86029b2470114fb4
Author: Oleksiy Petrenko <email address hidden>
Date: Thu Apr 26 15:29:57 2018 +0300

    Rework AseertEqual params order in freezer-api
    from (got, expected) to (expected, got)

    Change-Id: Id4ec8f561ce707fbbb60ae49bf5ad95d22ecd223
    Close-Bug: #1259292

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/485050
Committed: https://git.openstack.org/cgit/openstack/blazar/commit/?id=3fdac0da7dc2ca752b9dd9de854c16e1d8debf1b
Submitter: Zuul
Branch: master

commit 3fdac0da7dc2ca752b9dd9de854c16e1d8debf1b
Author: Kiran_totad <email address hidden>
Date: Wed Jul 19 11:33:48 2017 +0530

    Fix order of arguments in assertEqual

    Some tests incorrectly used the order assertEqual(observed, expected).

    The correct order expected by testtools is
    assertEqual(expected, observed).

    Change-Id: Idbb127147df5acc03287b6a7c1f8d24a37fd663e
    Closes-Bug: #1259292

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/blazar 3.0.0.0rc1 release candidate.