Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add unit test for HashAvatar #25662

Merged
merged 3 commits into from
Jul 4, 2023
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions modules/avatar/hash_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
// Copyright 2023 The Forgejo Authors. All rights reserved.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
// Copyright 2023 The Forgejo Authors. All rights reserved.
// Copyright 2023 The Gitea Authors. All rights reserved.

I think the CI won't pass otherwise.

Copy link
Member

@techknowlogick techknowlogick Jul 4, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As a point of clarification, will you be able to provide the copyright assignment? By introducing code from another project without the copyright assignment it raises many questions including "are we required to add the notice to the license file in the root of the git directory", among others.
Edit: this isn't anything new and has been a part of our CI verification for years.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I propose to just do it as with other gogs code ...
... two lines

Copy link
Contributor

@wxiaoguang wxiaoguang Jul 4, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I do not think it makes sense to add more and more headers.

Otherwise I would think it's also right to add my personal name to this header like "Copyright the Gitea Authors, Copyright wxiaoguang"

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well we are talking about projekt's and not about individual contributors ... but i get your concern

// SPDX-License-Identifier: MIT

package avatar_test

Check failure on line 4 in modules/avatar/hash_test.go

View workflow job for this annotation

GitHub Actions / lint-backend

Copyright did not match check

Check failure on line 4 in modules/avatar/hash_test.go

View workflow job for this annotation

GitHub Actions / lint-go-windows

Copyright did not match check

import (
"bytes"
"image"
"image/png"
"testing"

"code.gitea.io/gitea/modules/avatar"

"github.com/stretchr/testify/assert"
)

func Test_HashAvatar(t *testing.T) {
myImage := image.NewRGBA(image.Rect(0, 0, 32, 32))
var buff bytes.Buffer
png.Encode(&buff, myImage)

assert.EqualValues(t, "9ddb5bac41d57e72aa876321d0c09d71090c05f94bc625303801be2f3240d2cb", avatar.HashAvatar(1, buff.Bytes()))
assert.EqualValues(t, "9a5d44e5d637b9582a976676e8f3de1dccd877c2fe3e66ca3fab1629f2f47609", avatar.HashAvatar(8, buff.Bytes()))
assert.EqualValues(t, "ed7399158672088770de6f5211ce15528ebd675e92fc4fc060c025f4b2794ccb", avatar.HashAvatar(1024, buff.Bytes()))
assert.EqualValues(t, "161178642c7d59eb25a61dddced5e6b66eae1c70880d5f148b1b497b767e72d9", avatar.HashAvatar(1024, []byte{}))
Comment on lines +22 to +25
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why are there multiple test cases? HashAvatar has no conditional code so every call has 100% coverage.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

According to HashAvatar's comment, they are for different cases:

  • 1 & 8 : different id, different hash
  • 1024, buff.Bytes() & 1024, []byte{}: different content, different hash

ps: actually the test could be simplified by removing the myImage, because HashAvatar can be tested with byte slice directly.

}
Loading