fix: update error returned when `oci.NewFromTar` is used with a non-tar file #793

ADorigi · 2024-07-21T00:11:03Z

fixes #640

This pull request includes the following changes:

Declaring a new error ErrNotTarFile
Condition to check if the given path points to a .tar file
Corresponding tests

Signed-off-by: Adnan Gulegulzar <gulegulzaradnan@gmail.com>

TerryHowe · 2024-07-21T00:20:25Z

internal/fs/tarfs/tarfs.go

+
+ extension := filepath.Ext(pathAbs)
+
+ if extension != ".tar" {


Are compressed formats supported here like tgz?

No, I believe they will not be.
Is there a list of extensions we need to support?

I can add them to the check and add corresponding tests for them too.

I imagine only tar, but I'm not sure.

The current tests work with the files hello-world.tar and test.tar. From my understanding, .tars are the only ones supported as of now.

What if the target file/directory name ends with .tar, but it is actually not a tar type? Or what if the file is a tar file but it does not have a .tar suffix in its name?

In tfs.indexEntries(), maybe we can return a friendly error if tr.Next() fails?

I think tfs.indexEntries would indeed be a better place for this check. We can check if EOF is reached before any entries are added to tfs. This would infer it is an empty file. While a non-tar file will give us an io.ErrUnexpectedEOF while reading it.

We can then give the user our custom exported error.

content/oci/readonlyoci_test.go

Wwwsylvia · 2024-07-22T07:57:09Z

internal/fs/tarfs/tarfs.go

+
+ extension := filepath.Ext(pathAbs)
+
+ if extension != ".tar" {


What if the target file/directory name ends with .tar, but it is actually not a tar type? Or what if the file is a tar file but it does not have a .tar suffix in its name?

Wwwsylvia · 2024-07-22T08:00:16Z

internal/fs/tarfs/tarfs.go

+
+ extension := filepath.Ext(pathAbs)
+
+ if extension != ".tar" {


In tfs.indexEntries(), maybe we can return a friendly error if tr.Next() fails?

Wwwsylvia · 2024-07-22T08:04:59Z

Hello @ADorigi , thank you for the PR! I just reviewed it and left some comments.
By the way, can you follow Conventional Commits and rename the PR title to something like "feat: ..."?

Signed-off-by: Adnan Gulegulzar <gulegulzaradnan@gmail.com>

ADorigi · 2024-07-23T03:11:01Z

Hi @Wwwsylvia
Please check the updates.
Now the check for non-tar file takes place in tfs.indexEntries()

codecov · 2024-07-23T06:51:57Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 78.03%. Comparing base (c8c2048) to head (51ec1d4).

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #793      +/-   ##
==========================================
+ Coverage   77.92%   78.03%   +0.10%     
==========================================
  Files          63       63              
  Lines        4694     4698       +4     
==========================================
+ Hits         3658     3666       +8     
+ Misses        656      654       -2     
+ Partials      380      378       -2

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

internal/fs/tarfs/testdata/nonempty.tar

internal/fs/tarfs/tarfs_test.go

errdef/errors.go

internal/fs/tarfs/tarfs.go

Wwwsylvia · 2024-07-23T07:31:53Z

Hi @ADorigi , the updated PR looks good overall. I left a few nit comments.

fix: updated error text Signed-off-by: Adnan Gulegulzar <gulegulzaradnan@gmail.com>

ADorigi · 2024-07-23T21:53:55Z

Hi @Wwwsylvia
I made the minor changes and updated the error message.

internal/fs/tarfs/tarfs.go

internal/fs/tarfs/tarfs_test.go

Signed-off-by: Adnan Gulegulzar <gulegulzaradnan@gmail.com>

internal/fs/tarfs/tarfs_test.go

Signed-off-by: Adnan Gulegulzar <gulegulzaradnan@gmail.com>

Wwwsylvia

LGTM with some thoughts. @shizhMSFT Please also take a look at this PR when you get a chance.

Wwwsylvia · 2024-07-25T03:04:16Z

internal/fs/tarfs/tarfs.go

+ if len(tfs.entries) == 0 {
+ // indicates the given file is empty
+ return fmt.Errorf("%s: file is empty: %w", tfs.path, errdef.ErrInvalidTarFile)


Just thinking out loud: From the tarfs point of view, the tar file can be empty. But since tarfs is an internal package and is only used by ReadOnlyStorage and ReadOnlyOCI, which requires oci-layout file in it, I think it makes sense to return an error for an empty tar file. 🤔

Wwwsylvia · 2024-07-25T05:58:18Z

cc @qweeah who opened the original issue

shizhMSFT

Set to Request changes to block merge as the original issue might be invalid.

shizhMSFT · 2024-07-25T05:29:35Z

internal/fs/tarfs/tarfs.go

+ if len(tfs.entries) == 0 {
+ // indicates the given file is empty
+ return fmt.Errorf("%s: file is empty: %w", tfs.path, errdef.ErrInvalidTarFile)
+ }


I don't think we should return error on empty valid tar files since it breaks the encapsulation principal.

If we really want to check for empty tar file, it should be checked in the caller.

shizhMSFT · 2024-07-25T06:13:21Z

internal/fs/tarfs/tarfs.go

+ if errors.Is(err, io.ErrUnexpectedEOF) {
+ // indicates that its either not a tarfile or it is a corrupted one
+ return fmt.Errorf("%s: %w", tfs.path, errdef.ErrInvalidTarFile)
+ }


The io.ErrUnexpectedEOF error itself indicates the tar file is corrupted. There is no need to wrap it to errdef.ErrInvalidTarFile.

ADorigi requested review from sajayantony, shizhMSFT, SteveLasker and Wwwsylvia as code owners July 21, 2024 00:11

fix: updating error handling for non tar files

995e97f

Signed-off-by: Adnan Gulegulzar <gulegulzaradnan@gmail.com>

ADorigi force-pushed the tarfile-error-update branch from a7514ae to 995e97f Compare July 21, 2024 00:12

ADorigi mentioned this pull request Jul 21, 2024

improve the returned error of oci.NewFromTar when the passed-in path is not a tarfile #640

Closed

TerryHowe reviewed Jul 21, 2024

View reviewed changes

Wwwsylvia requested changes Jul 22, 2024

View reviewed changes

fix: non-tar file check now done while indexing entries

7fc9e05

Signed-off-by: Adnan Gulegulzar <gulegulzaradnan@gmail.com>

ADorigi changed the title ~~Updating error returned when oci.NewFromTar is used with a non-tar file~~ fix: Updating error returned when oci.NewFromTar is used with a non-tar file Jul 23, 2024

Wwwsylvia reviewed Jul 23, 2024

View reviewed changes

internal/fs/tarfs/testdata/nonempty.tar Outdated Show resolved Hide resolved

internal/fs/tarfs/tarfs_test.go Outdated Show resolved Hide resolved

errdef/errors.go Outdated Show resolved Hide resolved

internal/fs/tarfs/tarfs.go Outdated Show resolved Hide resolved

fix: wrapped error to include file path

b5c7ebd

fix: updated error text Signed-off-by: Adnan Gulegulzar <gulegulzaradnan@gmail.com>

Wwwsylvia reviewed Jul 24, 2024

View reviewed changes

internal/fs/tarfs/tarfs.go Outdated Show resolved Hide resolved

internal/fs/tarfs/tarfs.go Outdated Show resolved Hide resolved

internal/fs/tarfs/tarfs_test.go Outdated Show resolved Hide resolved

fix: condensed the tests and added friendly message

275a44a

Signed-off-by: Adnan Gulegulzar <gulegulzaradnan@gmail.com>

Wwwsylvia reviewed Jul 24, 2024

View reviewed changes

internal/fs/tarfs/tarfs_test.go Show resolved Hide resolved

fix: separating test for tarfiles without extension

51ec1d4

Signed-off-by: Adnan Gulegulzar <gulegulzaradnan@gmail.com>

Wwwsylvia approved these changes Jul 25, 2024

View reviewed changes

shizhMSFT changed the title ~~fix: Updating error returned when oci.NewFromTar is used with a non-tar file~~ fix: update error returned when oci.NewFromTar is used with a non-tar file Jul 25, 2024

shizhMSFT requested changes Jul 25, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: update error returned when `oci.NewFromTar` is used with a non-tar file #793

fix: update error returned when `oci.NewFromTar` is used with a non-tar file #793

ADorigi commented Jul 21, 2024

TerryHowe Jul 21, 2024

ADorigi Jul 21, 2024

ADorigi Jul 21, 2024

TerryHowe Jul 21, 2024

ADorigi Jul 21, 2024

Wwwsylvia Jul 22, 2024

Wwwsylvia Jul 22, 2024

ADorigi Jul 22, 2024

Wwwsylvia Jul 22, 2024

Wwwsylvia Jul 22, 2024

Wwwsylvia commented Jul 22, 2024

ADorigi commented Jul 23, 2024

codecov bot commented Jul 23, 2024 •

edited

Loading

Wwwsylvia commented Jul 23, 2024

ADorigi commented Jul 23, 2024

Wwwsylvia left a comment

Wwwsylvia Jul 25, 2024

Wwwsylvia commented Jul 25, 2024

shizhMSFT left a comment

shizhMSFT Jul 25, 2024

shizhMSFT Jul 25, 2024

fix: update error returned when oci.NewFromTar is used with a non-tar file #793

Are you sure you want to change the base?

fix: update error returned when oci.NewFromTar is used with a non-tar file #793

Conversation

ADorigi commented Jul 21, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Wwwsylvia commented Jul 22, 2024

ADorigi commented Jul 23, 2024

codecov bot commented Jul 23, 2024 • edited Loading

Codecov Report

Wwwsylvia commented Jul 23, 2024

ADorigi commented Jul 23, 2024

Wwwsylvia left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Wwwsylvia commented Jul 25, 2024

shizhMSFT left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fix: update error returned when `oci.NewFromTar` is used with a non-tar file #793

fix: update error returned when `oci.NewFromTar` is used with a non-tar file #793

codecov bot commented Jul 23, 2024 •

edited

Loading