Fix an issue that tools/license.py fails when BUILD.gn is not directly

Fix an issue that tools/license.py fails when BUILD.gn is not directly
under third_party/* directory.

e.g., FindThirdPartyDeps() currently returns
".../third_party/cld_3/src/src" where it should be
".../third_party/cld_3".

I can reproduce the issue by:
$ git cl patch 2797403002
$ tools/licenses.py --gn-target=//ios/web_view \
  --gn-out-dir=out/Debug-iphonesimulator license_file

I'm planning to reuse this script to generate LICENSE file for
//ios/web_view, and encountered this issue.

Review-Url: https://codereview.chromium.org/2802723004
Cr-Commit-Position: refs/heads/master@{#465497}
Committed: https://chromium.googlesource.com/chromium/src/+/baea08206b03227c71eeafa328185c5741f4f2e5

[Hiroshi Ichikawa, 2017-04-06 04:16:22]

ichikawa@chromium.org changed reviewers:
+ phajdan.jr@chromium.org

[Paweł Hajdan Jr., 2017-04-06 11:55:09]

I may need more context what the specific issue is.

It could also help to add unit tests for this function to demonstrate what's the
expected behavior.

https://codereview.chromium.org/2802723004/diff/20001/tools/licenses.py
File tools/licenses.py (right):

https://codereview.chromium.org/2802723004/diff/20001/tools/licenses.py#newco...
tools/licenses.py:494: m =
re.search(r"^(.+/third_party/[^/]+)/(.+/)?BUILD\.gn$", build_dep)
nit: Use single quotes ' .

[Hiroshi Ichikawa, 2017-04-07 02:16:43]

Description was changed from

==========
Fix an issue that tools/license.py fails when BUILD.gn is not directly
under third_party/* directory.

e.g., FindThirdPartyDeps() currently returns
".../third_party/cld_3/src/src" where it should be
".../third_party/cld_3".

I can reproduce the issue by:
$ tools/licenses.py --gn-target=//ios/web_view \
  --gn-out-dir=out/Debug-iphonesimulator credits

I'm planning to reuse this script to generate LICENSE file for
//ios/web_view, and encountered this issue.
==========

to

==========
Fix an issue that tools/license.py fails when BUILD.gn is not directly
under third_party/* directory.

e.g., FindThirdPartyDeps() currently returns
".../third_party/cld_3/src/src" where it should be
".../third_party/cld_3".

I can reproduce the issue by:
$ git cl patch 2797403002
$ tools/licenses.py --gn-target=//ios/web_view \
  --gn-out-dir=out/Debug-iphonesimulator license_file

I'm planning to reuse this script to generate LICENSE file for
//ios/web_view, and encountered this issue.
==========

[Hiroshi Ichikawa, 2017-04-07 05:07:41]

On 2017/04/06 11:55:09, Paweł Hajdan Jr. wrote:
> I may need more context what the specific issue is.

One correction: I found the issue is not reproduced by the command I initially
wrote in this CL description. It reproduces only with "license_file" action I'm
adding with CL 2797403002.

This is the command to reproduce the issue:

$ git cl patch 2797403002
$ tools/licenses.py --gn-target=//ios/web_view \
  --gn-out-dir=out/Debug-iphonesimulator license_file
Traceback (most recent call last):
  File "tools/licenses.py", line 715, in <module>
    sys.exit(main())
  File "tools/licenses.py", line 707, in main
    args.output_file, args.gn_out_dir, args.gn_target):
  File "tools/licenses.py", line 660, in GenerateLicenseFile
    directory, _REPOSITORY_ROOT, require_license_file=True)
  File "tools/licenses.py", line 362, in ParseDir
    raise LicenseError("missing README.chromium or licenses.py "
__main__.LicenseError: missing README.chromium or licenses.py SPECIAL_CASES
entry

It happens because:

1. GN returns a dependency //third_party/cld_3/src/src/BUILD.gn
2. FindThirdPartyDeps() returns ".../third_party/cld_3/src/src"
3. ParseDir() fails because it cannot find
".../third_party/cld_3/src/src/README.chromium"

And this CL fixes the issue by returning ".../third_party/cld_3" instead in the
step 2.

> 
> It could also help to add unit tests for this function to demonstrate what's
the
> expected behavior.

It's tricky to write unit test for FindThirdPartyDeps() (which internally
invokes gn command). So I extracted GetThirdPartyDepsFromGNDepsOutput() function
from  FindThirdPartyDeps() and wrote test for it.

I couldn't find existing test for license.py, and I was not sure where to put
the test. Let me know if there's a better location for the test.

[Hiroshi Ichikawa, 2017-04-07 05:07:51]

https://codereview.chromium.org/2802723004/diff/20001/tools/licenses.py
File tools/licenses.py (right):

https://codereview.chromium.org/2802723004/diff/20001/tools/licenses.py#newco...
tools/licenses.py:494: m =
re.search(r"^(.+/third_party/[^/]+)/(.+/)?BUILD\.gn$", build_dep)
On 2017/04/06 11:55:09, Paweł Hajdan Jr. wrote:
> nit: Use single quotes ' .

Done.

[Hiroshi Ichikawa, 2017-04-14 02:27:56]

PTAL?

[Paweł Hajdan Jr., 2017-04-18 20:22:19]

LGTM

[Hiroshi Ichikawa, 2017-04-19 01:47:33]

The CQ bit was checked by ichikawa@chromium.org

[commit-bot: I haz the power, 2017-04-19 01:47:49]

CQ is trying da patch. Follow status at
 
https://chromium-cq-status.appspot.com/v2/patch-status/codereview.chromium.or...

[commit-bot: I haz the power, 2017-04-19 01:51:00]

The CQ bit was unchecked by commit-bot@chromium.org

[commit-bot: I haz the power, 2017-04-19 01:51:00]

Try jobs failed on following builders:
  cast_shell_linux on master.tryserver.chromium.linux (JOB_FAILED,
http://build.chromium.org/p/tryserver.chromium.linux/builders/cast_shell_linu...)
  chromium_presubmit on master.tryserver.chromium.linux (JOB_FAILED,
http://build.chromium.org/p/tryserver.chromium.linux/builders/chromium_presub...)
  linux_chromium_asan_rel_ng on master.tryserver.chromium.linux (JOB_FAILED,
http://build.chromium.org/p/tryserver.chromium.linux/builders/linux_chromium_...)
  linux_chromium_chromeos_ozone_rel_ng on master.tryserver.chromium.linux
(JOB_FAILED,
http://build.chromium.org/p/tryserver.chromium.linux/builders/linux_chromium_...)
  linux_chromium_rel_ng on master.tryserver.chromium.linux (JOB_FAILED,
http://build.chromium.org/p/tryserver.chromium.linux/builders/linux_chromium_...)
  linux_chromium_tsan_rel_ng on master.tryserver.chromium.linux (JOB_FAILED,
http://build.chromium.org/p/tryserver.chromium.linux/builders/linux_chromium_...)
  ios-device on master.tryserver.chromium.mac (JOB_FAILED,
http://build.chromium.org/p/tryserver.chromium.mac/builders/ios-device/builds...)

[Hiroshi Ichikawa, 2017-04-19 01:58:32]

The CQ bit was checked by ichikawa@chromium.org

[Hiroshi Ichikawa, 2017-04-19 01:58:32]

The patchset sent to the CQ was uploaded after l-g-t-m from
phajdan.jr@chromium.org
Link to the patchset: https://codereview.chromium.org/2802723004/#ps100001
(title: "Rebase.")

[commit-bot: I haz the power, 2017-04-19 01:58:51]

CQ is trying da patch. Follow status at
 
https://chromium-cq-status.appspot.com/v2/patch-status/codereview.chromium.or...

[commit-bot: I haz the power, 2017-04-19 02:06:23]

The CQ bit was unchecked by commit-bot@chromium.org

[commit-bot: I haz the power, 2017-04-19 02:06:24]

Try jobs failed on following builders:
  chromium_presubmit on master.tryserver.chromium.linux (JOB_FAILED,
http://build.chromium.org/p/tryserver.chromium.linux/builders/chromium_presub...)

[Hiroshi Ichikawa, 2017-04-19 03:52:13]

ichikawa@chromium.org changed reviewers:
+ scottmg@chromium.org

[Hiroshi Ichikawa, 2017-04-19 03:52:13]

scottmg@: Can you review addition of these two new files, or point me a better
location for unit tests for //tools?

 tools/tests/OWNERS
 tools/tests/licenses_test.py

[scottmg, 2017-04-19 04:25:16]

rs lgtm based on phajdan's review.

https://codereview.chromium.org/2802723004/diff/120001/tools/tests/OWNERS
File tools/tests/OWNERS (right):

https://codereview.chromium.org/2802723004/diff/120001/tools/tests/OWNERS#new...
tools/tests/OWNERS:1: dpranke@chromium.org
No need for these additions, as there's no `set noparent` here, so tools/OWNERS
is in effect.

[Hiroshi Ichikawa, 2017-04-19 04:33:24]

https://codereview.chromium.org/2802723004/diff/120001/tools/tests/OWNERS
File tools/tests/OWNERS (right):

https://codereview.chromium.org/2802723004/diff/120001/tools/tests/OWNERS#new...
tools/tests/OWNERS:1: dpranke@chromium.org
On 2017/04/19 04:25:15, scottmg wrote:
> No need for these additions, as there's no `set noparent` here, so
tools/OWNERS
> is in effect.

Done.

[Hiroshi Ichikawa, 2017-04-19 04:33:53]

The CQ bit was checked by ichikawa@chromium.org

[Hiroshi Ichikawa, 2017-04-19 04:33:53]

The patchset sent to the CQ was uploaded after l-g-t-m from
phajdan.jr@chromium.org, scottmg@chromium.org
Link to the patchset: https://codereview.chromium.org/2802723004/#ps140001
(title: "Apply review comments.")

[commit-bot: I haz the power, 2017-04-19 04:34:11]

CQ is trying da patch. Follow status at
 
https://chromium-cq-status.appspot.com/v2/patch-status/codereview.chromium.or...

[commit-bot: I haz the power, 2017-04-19 05:24:05]

CQ is committing da patch.

Bot data: {"patchset_id": 140001, "attempt_start_ts": 1492576433232360,
"parent_rev": "14d1d43db61eecd4bbf87423bfe246ca0fcb4778", "commit_rev":
"baea08206b03227c71eeafa328185c5741f4f2e5"}

[commit-bot: I haz the power, 2017-04-19 05:24:46]

Description was changed from

==========
Fix an issue that tools/license.py fails when BUILD.gn is not directly
under third_party/* directory.

e.g., FindThirdPartyDeps() currently returns
".../third_party/cld_3/src/src" where it should be
".../third_party/cld_3".

I can reproduce the issue by:
$ git cl patch 2797403002
$ tools/licenses.py --gn-target=//ios/web_view \
  --gn-out-dir=out/Debug-iphonesimulator license_file

I'm planning to reuse this script to generate LICENSE file for
//ios/web_view, and encountered this issue.
==========

to

==========
Fix an issue that tools/license.py fails when BUILD.gn is not directly
under third_party/* directory.

e.g., FindThirdPartyDeps() currently returns
".../third_party/cld_3/src/src" where it should be
".../third_party/cld_3".

I can reproduce the issue by:
$ git cl patch 2797403002
$ tools/licenses.py --gn-target=//ios/web_view \
  --gn-out-dir=out/Debug-iphonesimulator license_file

I'm planning to reuse this script to generate LICENSE file for
//ios/web_view, and encountered this issue.

Review-Url: https://codereview.chromium.org/2802723004
Cr-Commit-Position: refs/heads/master@{#465497}
Committed:
https://chromium.googlesource.com/chromium/src/+/baea08206b03227c71eeafa32818...
==========

[commit-bot: I haz the power, 2017-04-19 05:24:52]

Committed patchset #8 (id:140001) as
https://chromium.googlesource.com/chromium/src/+/baea08206b03227c71eeafa32818...