add Extensions and Detection Order (Extensions)

[harikannan512]

Summary

Adding Extensions section to the output of pack builder inspect

Output

Before

(picked from Unit test output to confirm output format)

REMOTE:

Description: Some remote description

Created By:
  Name: Pack CLI
  Version: 1.2.3

Trusted: No

Stack:
  ID: test.stack.id

Lifecycle:
  Version: 6.7.8
  Buildpack APIs:
    Deprecated: (none)
    Supported: 1.2, 2.3
  Platform APIs:
    Deprecated: 0.1, 1.2
    Supported: 4.5

Run Images:
  first/local     (user-configured)
  second/local    (user-configured)
  some/run-image
  first/default
  second/default

Buildpacks:
  ID                     NAME        VERSION                        HOMEPAGE
  test.top.nested        -           test.top.nested.version        -
  test.nested            -                                          http://geocities.com/top-bp
  test.bp.one            -           test.bp.one.version            http://geocities.com/cool-bp
  test.bp.two            -           test.bp.two.version            -
  test.bp.three          -           test.bp.three.version          -

Detection Order:
 ├ Group #1:
 │  ├ test.top.nested@test.top.nested.version
 │  │  └ Group #1:
 │  │     ├ test.nested
 │  │     │  └ Group #1:
 │  │     │     └ test.bp.one@test.bp.one.version      (optional)
 │  │     ├ test.bp.three@test.bp.three.version        (optional)
 │  │     └ test.nested.two@test.nested.two.version
 │  │        └ Group #2:
 │  │           └ test.bp.one@test.bp.one.version    (optional)[cyclic]
 │  └ test.bp.two@test.bp.two.version                (optional)
 └ test.bp.three@test.bp.three.version

After

(picked from Unit test output to confirm output format)

REMOTE:

Description: Some remote description

Created By:
  Name: Pack CLI
  Version: 1.2.3

Trusted: No

Stack:
  ID: test.stack.id

Lifecycle:
  Version: 6.7.8
  Buildpack APIs:
    Deprecated: (none)
    Supported: 1.2, 2.3
  Platform APIs:
    Deprecated: 0.1, 1.2
    Supported: 4.5

Run Images:
  first/local     (user-configured)
  second/local    (user-configured)
  some/run-image
  first/default
  second/default

Buildpacks:
  ID                     NAME        VERSION                        HOMEPAGE
  test.top.nested        -           test.top.nested.version        -
  test.nested            -                                          http://geocities.com/top-bp
  test.bp.one            -           test.bp.one.version            http://geocities.com/cool-bp
  test.bp.two            -           test.bp.two.version            -
  test.bp.three          -           test.bp.three.version          -

Detection Order:
 ├ Group #1:
 │  ├ test.top.nested@test.top.nested.version
 │  │  └ Group #1:
 │  │     ├ test.nested
 │  │     │  └ Group #1:
 │  │     │     └ test.bp.one@test.bp.one.version      (optional)
 │  │     ├ test.bp.three@test.bp.three.version        (optional)
 │  │     └ test.nested.two@test.nested.two.version
 │  │        └ Group #2:
 │  │           └ test.bp.one@test.bp.one.version    (optional)[cyclic]
 │  └ test.bp.two@test.bp.two.version                (optional)
 └ test.bp.three@test.bp.three.version

Extensions:
  ID                     NAME        VERSION                        HOMEPAGE
  test.top.nested        -           test.top.nested.version        -
  test.nested            -                                          http://geocities.com/top-bp
  test.bp.one            -           test.bp.one.version            http://geocities.com/cool-bp
  test.bp.two            -           test.bp.two.version            -
  test.bp.three          -           test.bp.three.version          -

Detection Order (Extensions):
 ├ Group #1:
 │  ├ test.top.nested@test.top.nested.version
 │  │  └ Group #1:
 │  │     ├ test.nested
 │  │     │  └ Group #1:
 │  │     │     └ test.bp.one@test.bp.one.version      (optional)
 │  │     ├ test.bp.three@test.bp.three.version        (optional)
 │  │     └ test.nested.two@test.nested.two.version
 │  │        └ Group #2:
 │  │           └ test.bp.one@test.bp.one.version    (optional)[cyclic]
 │  └ test.bp.two@test.bp.two.version                (optional)
 └ test.bp.three@test.bp.three.version

Documentation

• Should this change be documented?
  • Yes, see extensions-phases-1
  • No

Related

#1488
#1478

Resolves #1488

[harikannan512]

@natalieparellano can I get some information on how acceptance tests are set up and how can they be accommodated for changes? It would be great if I can get an example PR or some documentation of some sort. Apologies, It's my first time contributing to open source. Thanks a lot.

[natalieparellano]

@harikannan512 thanks for the PR! I see that it's currently in draft - are you looking for any feedback at this stage?

[harikannan512]

@natalieparellano yes. The reason its in the draft is I am trying to understand acceptance tests to add to it, but I am afraid I can't really understand where to begin. Thanks!

[codecov]

Codecov Report

Merging #1581 (59685b5) into main (434437a) will decrease coverage by 0.04%.
The diff coverage is 80.19%.

❗ Current head 59685b5 differs from pull request most recent head 54a04e2. Consider uploading reports for the commit 54a04e2 to get more accurate results

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1581      +/-   ##
==========================================
- Coverage   81.14%   81.10%   -0.03%     
==========================================
  Files         156      156              
  Lines       10362    10455      +93     
==========================================
+ Hits         8407     8479      +72     
- Misses       1458     1472      +14     
- Partials      497      504       +7     

Flag	Coverage Δ
os_linux	79.88% <80.19%> (-0.05%)	⬇️
os_macos	77.42% <80.19%> (-0.02%)	⬇️
os_windows	80.96% <80.19%> (-0.06%)	⬇️
unit	81.10% <80.19%> (-0.03%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

[natalieparellano]

@harikannan512 thanks so much for the PR, these changes look really great!

Regarding the acceptance test, you could update this test with an assertion around the output of pack builder inspect. Something like output = pack.RunSuccessfully("builder", "inspect", builderName) and then asserting on the output.

We should also try passing --output json (or something other than human-readable) as I don't believe your changes yet cover that case, but it should be a simple change to this file to get it working.

[natalieparellano]

We may need to pull in #1589 to get the Windows tests passing

[natalieparellano]

Awesome work @harikannan512! This looks good to me... @buildpacks/toc could we please get a review?

[dfreilich]

Unbelievable work! Thanks so much for the help!