support to upload pdf file

Author: LinuxSuRen

console/atest-ui/src/views/TemplateFunctions.vue

@@ -28,25 +28,33 @@ Magic.Keys(() => {
             data-intro="You can search your desired template functions.">{{ t('button.toolbox') }}</el-button>
     </el-affix>
 
-    <el-dialog v-model="dialogVisible" :title="t('title.templateQuery')" width="40%" draggable destroy-on-close>
-        <template #footer>
-            <el-input v-model="query" placeholder="Query after enter" v-on:keyup.enter="queryFuncs" />
-            <span class="dialog-footer">
-                <el-table :data="funcs" style="width: 100%">
-                    <el-table-column label="Key" width="250">
-                        <template #default="scope">
-                            <el-input v-model="scope.row.key" placeholder="Value" />
-                        </template>
-                    </el-table-column>
-                    <el-table-column label="Value">
-                        <template #default="scope">
-                            <div style="display: flex; align-items: center">
-                                <el-input v-model="scope.row.value" placeholder="Value" />
-                            </div>
-                        </template>
-                    </el-table-column>
-                </el-table>
-            </span>
-        </template>
+    <el-dialog v-model="dialogVisible" :title="t('title.templateQuery')" width="50%" draggable destroy-on-close>
+        <el-input
+            v-model="query" placeholder="Query after enter" v-on:keyup.enter="queryFuncs">
+            <template #append v-if="funcs.length > 0">
+                {{ funcs.length }}
+            </template>
+        </el-input>
+        <span class="dialog-footer">
+            <el-table :data="funcs">
+                <el-table-column label="Name" width="250">
+                    <template #default="scope">
+                        {{ scope.row.key }}
+                    </template>
+                </el-table-column>
+                <el-table-column label="Function">
+                    <template #default="scope">
+                        {{ scope.row.value }}
+                    </template>
+                </el-table-column>
+                <el-table-column label="Usage">
+                    <template #default="scope">
+                        <div style="display: flex; align-items: center">
+                            <el-input v-model="scope.row.description" readonly />
+                        </div>
+                    </template>
+                </el-table-column>
+            </el-table>
+        </span>
     </el-dialog>
 </template>

console/atest-ui/src/views/TestCase.vue

@@ -721,6 +721,15 @@ function formChange() {
   }
 }
 
+const filepathChange = () => {
+  const items = testCaseWithSuite.value.data.request.filepath.split("=")
+      if (items && items.length > 1) {
+        testCaseWithSuite.value.data.request.form = [{
+          key: items[0],
+          value: items[1]
+        } as Pair]
+      }
+}
 const bodyType = ref(1)
 function bodyTypeChange(e: number) {
   let contentType = ""
@@ -733,14 +742,7 @@ function bodyTypeChange(e: number) {
       break;
     case 6:
       contentType = 'multipart/form-data'
-
-      const items = testCaseWithSuite.value.data.request.filepath.split("=")
-      if (items && items.length > 1) {
-        testCaseWithSuite.value.data.request.form = [{
-          key: items[0],
-          value: items[1]
-        } as Pair]
-      }
+      filepathChange()
       break;
   }
 
@@ -1025,7 +1027,7 @@ Magic.Keys(() => {
               <el-row>
                 <el-col :span="4">Filename:</el-col>
                 <el-col :span="20">
-                  <el-input v-model="testCaseWithSuite.data.request.filepath" placeholder="file=sample.txt" />
+                  <el-input v-model="testCaseWithSuite.data.request.filepath" placeholder="file=sample.txt" @change="filepathChange" />
                 </el-col>
               </el-row>
             </div>

pkg/render/data/templateUsage.yaml

@@ -0,0 +1,6 @@
+randImage: |
+  {{ randImage width height }}
+randAscii: |
+  {{ randAscii count }}
+randPdf: |
+  {{ randPdf }}

pkg/render/image.go

@@ -30,6 +30,20 @@ import (
 )
 
 func generateRandomImage(width, height int) (data string, err error) {
+	// avoid unexpected image size
+	if width < 4 {
+		width = 4
+	}
+	if height < 4 {
+		height = 4
+	}
+	if width > 2048 {
+		width = 2048
+	}
+	if height > 2048 {
+		height = 2048
+	}
+
 	img := image.NewRGBA(image.Rect(0, 0, width, height))
 	blockSize := int(math.Max(float64(width), float64(height)) / 4)
 	rand.Seed(time.Now().UnixNano())

pkg/render/image_test.go

@@ -0,0 +1,48 @@
+/*
+Copyright 2024 API Testing Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+	http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language 24 permissions and
+limitations under the License.
+*/
+package render
+
+import (
+	"encoding/base64"
+	"strings"
+	"testing"
+
+	"github.com/linuxsuren/api-testing/pkg/util"
+	"github.com/stretchr/testify/assert"
+)
+
+func TestRandImage(t *testing.T) {
+	tests := []struct {
+		width, height int
+	}{{
+		width:  0,
+		height: 10,
+	}, {
+		width:  10,
+		height: -1,
+	}, {
+		width:  10240,
+		height: 10240,
+	}}
+	for _, tt := range tests {
+		data, err := generateRandomImage(tt.width, tt.height)
+		assert.NoError(t, err, err)
+
+		imageStr := strings.TrimPrefix(string(data), util.ImageBase64Prefix)
+		_, err = base64.StdEncoding.DecodeString(imageStr)
+		assert.NoError(t, err, err)
+	}
+}

pkg/render/pdf.go

@@ -15,6 +15,46 @@ limitations under the License.
 */
 package render
 
-func generateRandomPdf() (data []byte, err error) {
+import (
+	"bytes"
+	"encoding/base64"
+	"fmt"
+	"time"
+
+	"github.com/flopp/go-findfont"
+	"github.com/linuxsuren/api-testing/pkg/util"
+	"github.com/signintech/gopdf"
+)
+
+func generateRandomPdf() (data string, err error) {
+	pdf := gopdf.GoPdf{}
+	pdf.Start(gopdf.Config{PageSize: *gopdf.PageSizeA4})
+
+	var fontPath string
+	if fontPath, err = findfont.Find(""); err == nil {
+		if err = pdf.AddTTFFont("wts11", fontPath); err != nil {
+			return
+		}
+
+		if err = pdf.SetFont("wts11", "", 14); err != nil {
+			return
+		}
+	} else {
+		return
+	}
+
+	pdf.AddHeader(func() {})
+	pdf.AddFooter(func() {})
+	pdf.AddPage()
+	if err = pdf.Text(fmt.Sprintf("Generated by atest at %v", time.Now())); err != nil {
+		err = fmt.Errorf("failed to generate pdf content: %v", err)
+		return
+	}
+
+	buf := new(bytes.Buffer)
+	if _, err = pdf.WriteTo(buf); err == nil {
+		fmt.Println("write pdf successfully")
+		data = fmt.Sprintf("%s%s", util.PDFBase64Prefix, base64.StdEncoding.EncodeToString(buf.Bytes()))
+	}
 	return
 }

pkg/render/pdf_test.go

@@ -0,0 +1,28 @@
+/*
+Copyright 2024 API Testing Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+	http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language 24 permissions and
+limitations under the License.
+*/
+package render
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestRandPdf(t *testing.T) {
+	data, err := generateRandomPdf()
+	assert.NotEmpty(t, data)
+	assert.NoError(t, err, err)
+}

pkg/render/template.go

@@ -21,6 +21,7 @@ import (
 	"crypto/md5"
 	"crypto/rand"
 	"crypto/sha256"
+	_ "embed"
 	"encoding/base64"
 	"encoding/hex"
 	"encoding/json"
@@ -38,6 +39,7 @@ import (
 	"github.com/Masterminds/sprig/v3"
 	"github.com/linuxsuren/api-testing/pkg/secret"
 	"github.com/linuxsuren/api-testing/pkg/util"
+	"gopkg.in/yaml.v3"
 )
 
 var secretGetter secret.SecretGetter
@@ -97,6 +99,15 @@ func FuncMap() template.FuncMap {
 	return funcs
 }
 
+// FuncUsage returns the usage of target template function
+func FuncUsage(funcName string) (usage string) {
+	usageMap := make(map[string]string)
+	if err := yaml.Unmarshal(templateUsage, usageMap); err == nil {
+		usage = usageMap[funcName]
+	}
+	return
+}
+
 // RenderThenPrint renders the template then prints the result
 func RenderThenPrint(name, text string, ctx interface{}, w io.Writer) (err error) {
 	var report string
@@ -251,3 +262,6 @@ func rasEncryptWithPublicKey(content, key string) (string, error) {
 
 	return base64.StdEncoding.EncodeToString(encryptedData), nil
 }
+
+//go:embed data/templateUsage.yaml
+var templateUsage []byte

pkg/render/template_test.go

@@ -280,3 +280,12 @@ func TestRasEncryptWithPublicKey(t *testing.T) {
 		t.Fatalf("Decrypted message does not match original. Got: %s, want: %s", decryptedMessage, message)
 	}
 }
+
+func TestFuncUsages(t *testing.T) {
+	funcs := []string{"randImage"}
+
+	for _, f := range funcs {
+		usage := FuncUsage(f)
+		assert.NotEmpty(t, usage)
+	}
+}

pkg/server/remote_server.go

@@ -1010,8 +1010,9 @@ func (s *server) FunctionsQuery(ctx context.Context, in *SimpleQuery) (reply *Pa
 		lowerCaseName := strings.ToLower(name)
 		if in.Name == "" || strings.Contains(lowerCaseName, in.Name) {
 			reply.Data = append(reply.Data, &Pair{
-				Key:   name,
-				Value: fmt.Sprintf("%v", reflect.TypeOf(fn)),
+				Key:         name,
+				Value:       fmt.Sprintf("%v", reflect.TypeOf(fn)),
+				Description: render.FuncUsage(name),
 			})
 		}
 	}