code.gitea.io/gitea@v1.22.3/modules/avatar/avatar_test.go (about)

     1  // Copyright 2016 The Gogs Authors. All rights reserved.
     2  // SPDX-License-Identifier: MIT
     3  
     4  package avatar
     5  
     6  import (
     7  	"bytes"
     8  	"image"
     9  	"image/png"
    10  	"os"
    11  	"testing"
    12  
    13  	"code.gitea.io/gitea/modules/setting"
    14  
    15  	"github.com/stretchr/testify/assert"
    16  )
    17  
    18  func Test_RandomImageSize(t *testing.T) {
    19  	_, err := RandomImageSize(0, []byte("gitea@local"))
    20  	assert.Error(t, err)
    21  
    22  	_, err = RandomImageSize(64, []byte("gitea@local"))
    23  	assert.NoError(t, err)
    24  }
    25  
    26  func Test_RandomImage(t *testing.T) {
    27  	_, err := RandomImage([]byte("gitea@local"))
    28  	assert.NoError(t, err)
    29  }
    30  
    31  func Test_ProcessAvatarPNG(t *testing.T) {
    32  	setting.Avatar.MaxWidth = 4096
    33  	setting.Avatar.MaxHeight = 4096
    34  
    35  	data, err := os.ReadFile("testdata/avatar.png")
    36  	assert.NoError(t, err)
    37  
    38  	_, err = processAvatarImage(data, 262144)
    39  	assert.NoError(t, err)
    40  }
    41  
    42  func Test_ProcessAvatarJPEG(t *testing.T) {
    43  	setting.Avatar.MaxWidth = 4096
    44  	setting.Avatar.MaxHeight = 4096
    45  
    46  	data, err := os.ReadFile("testdata/avatar.jpeg")
    47  	assert.NoError(t, err)
    48  
    49  	_, err = processAvatarImage(data, 262144)
    50  	assert.NoError(t, err)
    51  }
    52  
    53  func Test_ProcessAvatarInvalidData(t *testing.T) {
    54  	setting.Avatar.MaxWidth = 5
    55  	setting.Avatar.MaxHeight = 5
    56  
    57  	_, err := processAvatarImage([]byte{}, 12800)
    58  	assert.EqualError(t, err, "image.DecodeConfig: image: unknown format")
    59  }
    60  
    61  func Test_ProcessAvatarInvalidImageSize(t *testing.T) {
    62  	setting.Avatar.MaxWidth = 5
    63  	setting.Avatar.MaxHeight = 5
    64  
    65  	data, err := os.ReadFile("testdata/avatar.png")
    66  	assert.NoError(t, err)
    67  
    68  	_, err = processAvatarImage(data, 12800)
    69  	assert.EqualError(t, err, "image width is too large: 10 > 5")
    70  }
    71  
    72  func Test_ProcessAvatarImage(t *testing.T) {
    73  	setting.Avatar.MaxWidth = 4096
    74  	setting.Avatar.MaxHeight = 4096
    75  	scaledSize := DefaultAvatarSize * setting.Avatar.RenderedSizeFactor
    76  
    77  	newImgData := func(size int, optHeight ...int) []byte {
    78  		width := size
    79  		height := size
    80  		if len(optHeight) == 1 {
    81  			height = optHeight[0]
    82  		}
    83  		img := image.NewRGBA(image.Rect(0, 0, width, height))
    84  		bs := bytes.Buffer{}
    85  		err := png.Encode(&bs, img)
    86  		assert.NoError(t, err)
    87  		return bs.Bytes()
    88  	}
    89  
    90  	// if origin image canvas is too large, crop and resize it
    91  	origin := newImgData(500, 600)
    92  	result, err := processAvatarImage(origin, 0)
    93  	assert.NoError(t, err)
    94  	assert.NotEqual(t, origin, result)
    95  	decoded, err := png.Decode(bytes.NewReader(result))
    96  	assert.NoError(t, err)
    97  	assert.EqualValues(t, scaledSize, decoded.Bounds().Max.X)
    98  	assert.EqualValues(t, scaledSize, decoded.Bounds().Max.Y)
    99  
   100  	// if origin image is smaller than the default size, use the origin image
   101  	origin = newImgData(1)
   102  	result, err = processAvatarImage(origin, 0)
   103  	assert.NoError(t, err)
   104  	assert.Equal(t, origin, result)
   105  
   106  	// use the origin image if the origin is smaller
   107  	origin = newImgData(scaledSize + 100)
   108  	result, err = processAvatarImage(origin, 0)
   109  	assert.NoError(t, err)
   110  	assert.Less(t, len(result), len(origin))
   111  
   112  	// still use the origin image if the origin doesn't exceed the max-origin-size
   113  	origin = newImgData(scaledSize + 100)
   114  	result, err = processAvatarImage(origin, 262144)
   115  	assert.NoError(t, err)
   116  	assert.Equal(t, origin, result)
   117  
   118  	// allow to use known image format (eg: webp) if it is small enough
   119  	origin, err = os.ReadFile("testdata/animated.webp")
   120  	assert.NoError(t, err)
   121  	result, err = processAvatarImage(origin, 262144)
   122  	assert.NoError(t, err)
   123  	assert.Equal(t, origin, result)
   124  
   125  	// do not support unknown image formats, eg: SVG may contain embedded JS
   126  	origin = []byte("<svg></svg>")
   127  	_, err = processAvatarImage(origin, 262144)
   128  	assert.ErrorContains(t, err, "image: unknown format")
   129  
   130  	// make sure the canvas size limit works
   131  	setting.Avatar.MaxWidth = 5
   132  	setting.Avatar.MaxHeight = 5
   133  	origin = newImgData(10)
   134  	_, err = processAvatarImage(origin, 262144)
   135  	assert.ErrorContains(t, err, "image width is too large: 10 > 5")
   136  }