New issue
Advanced search Search tips

Issue 679612 link

Starred by 1 user

Issue metadata

Status: Fixed
Owner:
Closed: Sep 2017
Cc:
Components:
EstimatedDays: ----
NextAction: ----
OS: Chrome
Pri: 3
Type: Feature



Sign in to add a comment

[Factory] Type-C related tests name is confusing

Project Member Reported by shunhsingou@chromium.org, Jan 10 2017

Issue description

Type-C related tests have many legacy terms, many of which are wrong and also confusing.

In the factory repo and many project overlays (in their factory branches), we found the following:
- 'Raiden' sometimes means 'Type-C'. For example, we use 'no_raiden', which actually means 'no type-C' in GlaDOS' test list.
- 'Raiden' also means 'Plankton-Raiden'. For example, we have many raiden_xxxx.py pytests that actually means type-C test using Plankton-Raiden board.
- 'Dolphin' sometimes means Plankton-Raiden board. In GlaDOS, we design the test that use Plankton board only without NCU, so it's not really Dolphin.

The correct definition of those terms should be:
- Raiden: A Type-C chip that we built before.
- Plankton-Raiden: The board used for USB type-C test automation.
- Dolphin: The fixture used for USB type-C test automation, contains a Plankton-Raiden board and a NCU.

The propose here is to:
1. Use 'usb_c' to indicate USB type-C instead of using 'raiden'.
2. Use 'plankton' to indicate test with Plankton-Raiden board instead of using 'raiden'.
3. Remove name 'dolphin'. It's just 'plankton' with automatic display test.

We may also create a reference test list for device using/non-using plankton for Type-C tests.
 

Comment 1 by hungte@chromium.org, Jan 10 2017

Cc: marcochen@chromium.org
Labels: OS-Chrome
The proposal sounds good to me.

Raiden is the chipset name and not used by recent projects so it should be replaced to usb_c, same as what we named in Device API (py/device/usb_c.py).

I think we should create few "modules" in reference test list, just like "grt.py" so others can include and use functions defined inside.

Comment 2 by hungte@chromium.org, Jul 26 2017

Cc: -phoenixshen@chromium.org -hungte@chromium.org -stimim@chromium.org chromeos-factory-eng@google.com
Owner: yllin@chromium.org
Temporarily assign to yllin if you want to clean up.

Comment 3 by yllin@chromium.org, Aug 4 2017

Status: Started (was: Untriaged)

Comment 4 by yllin@chromium.org, Aug 7 2017

Should we also rephrase wordings under test/fixture/dolphin rather than only rephrase wordings under pytests?
Since they are the names of the specific fixture.

For example,
rename test/fixture/dolphin/dolphin_bft_fixture.py => test/fixture/plankton/plankton_bft_fixture.py


I think the fixture/dolphin contains exactly the code for Dolphin (fixture for testing plankton). Can you check with Earl to see if fixture/dolphin should be changed as well?
Project Member

Comment 6 by bugdroid1@chromium.org, Aug 8 2017

The following revision refers to this bug:
  https://chromium.googlesource.com/chromiumos/platform/factory/+/5dd329457243c53fd23858381a99e2eb22808130

commit 5dd329457243c53fd23858381a99e2eb22808130
Author: Yilun Lin <yllin@google.com>
Date: Tue Aug 08 08:11:39 2017

pytests: Unify USB type-C naming convention.

The wordings raiden, dolphin, and plankton in USB type-C related tests
are confusing:
  - 'Raiden' sometimes means 'Type-C'. For example, we use 'no_raiden', which
    actually means 'no type-C' in GlaDOS' test list.
  - 'Raiden' also means 'Plankton-Raiden'. For example, we have many
     raiden_xxxx.py pytests that actually means type-C test using
     Plankton-Raiden board.
  - 'Dolphin' sometimes means Plankton-Raiden board. In GlaDOS, we design
     the test that use Plankton board only without NCU, so it's not really
     Dolphin.

The CL changes the wording according to the guidelines here:
  - Use 'usb_c' to indicate USB type-C instead of 'raiden'
  - Use 'plankton' to indicate test with Plankton-Raiden board instead of
    'raiden'
  - Remove name 'dolphin'.

The detailed changes are listed as the following:
  pytests:
    - raiden_cc_flip_check.py => plankton_cc_flip_check.py
      class:
        - RaidenCCFlipCheck => PlanktonCCFlipCheck
      args:
        - raiden_index => usb_c_index

    - raiden_charge.py => plankton_charge.py
      class:
        - RaidenChargeBFTTest => PlanktonChargeBFTTest

    - raiden_cc2_pull_test.py => plankton_cc2_pull_test.py
      class:
        - RaidenCC2PullTest => PlanktonCC2PullTest
      args:
        - raiden_index => usb_c_index

    - raiden_display.py => plankton_display.py
      class:
        - RaidenDisplayTest => PlanktonDisplayTest
      args:
        - raiden_index => usb_c_index

  fixture:
    - dolphin_bft_fixture
      init params:
      - raiden_index => usb_c_index

TEST=manual check test items showing on device
TEST=make test
BUG= chromium:679612 

Change-Id: I9252e35863344e1b56342f3cdaad2979e7cdc9bd
Reviewed-on: https://chromium-review.googlesource.com/603347
Commit-Ready: Yilun Lin <yllin@chromium.org>
Tested-by: Yilun Lin <yllin@chromium.org>
Reviewed-by: Hung-Te Lin <hungte@chromium.org>
Reviewed-by: Shun-Hsing Ou <shunhsingou@chromium.org>

[rename] https://crrev.com/5dd329457243c53fd23858381a99e2eb22808130/py/test/pytests/plankton_cc_flip_check.py
[modify] https://crrev.com/5dd329457243c53fd23858381a99e2eb22808130/py/test/fixture/dolphin/dolphin_bft_fixture.py
[rename] https://crrev.com/5dd329457243c53fd23858381a99e2eb22808130/py/test/pytests/plankton_charge.py
[modify] https://crrev.com/5dd329457243c53fd23858381a99e2eb22808130/po/zh-CN.po
[rename] https://crrev.com/5dd329457243c53fd23858381a99e2eb22808130/py/test/pytests/plankton_display_static/template.tar.gz
[rename] https://crrev.com/5dd329457243c53fd23858381a99e2eb22808130/py/test/pytests/plankton_display_static/plankton_display.js
[rename] https://crrev.com/5dd329457243c53fd23858381a99e2eb22808130/py/test/pytests/plankton_display_static/plankton_display.css
[modify] https://crrev.com/5dd329457243c53fd23858381a99e2eb22808130/py/test/fixture/bft_fixture.py
[rename] https://crrev.com/5dd329457243c53fd23858381a99e2eb22808130/py/test/pytests/plankton_display.py
[rename] https://crrev.com/5dd329457243c53fd23858381a99e2eb22808130/py/test/pytests/plankton_display_static/wallpaper.tar.gz
[rename] https://crrev.com/5dd329457243c53fd23858381a99e2eb22808130/py/test/pytests/plankton_cc2_pull_test.py

Comment 7 by hungte@chromium.org, Sep 26 2017

Status: Fixed (was: Started)
yllin, I think this is all fixed right?

Comment 8 by yllin@google.com, Sep 26 2017

yes, please closed this issue.

Comment 9 by dchan@chromium.org, Jan 22 2018

Status: Archived (was: Fixed)

Comment 10 by dchan@chromium.org, Jan 23 2018

Status: Fixed (was: Archived)

Sign in to add a comment