feat: complete a very basic test

Author: LinuxSuRen

.gitignore

@@ -0,0 +1,3 @@
+coverage.out
+bin/
+.idea/

.goreleaser.yaml

@@ -0,0 +1,40 @@
+# This is an example .goreleaser.yml file with some sensible defaults.
+# Make sure to check the documentation at https://goreleaser.com
+before:
+  hooks:
+    # You may remove this if you don't use go modules.
+    - go mod tidy
+builds:
+  - env:
+      - CGO_ENABLED=0
+    id: atest-store-iotdb
+    binary: atest-store-iotdb
+    goos:
+      - linux
+      - windows
+      - darwin
+    ignore:
+      - goarch: 386
+    ldflags:
+      - -w
+      - -s
+      - -X github.com/linuxsuren/api-testing/pkg/version.version={{.Version}} -X github.com/linuxsuren/api-testing/pkg/version.commit={{.Commit}} -X github.com/linuxsuren/api-testing/pkg/version.date={{.Date}}
+archives:
+  - name_template: "{{ .Binary }}-{{ .Os }}-{{ .Arch }}"
+    builds:
+      - atest-store-iotdb
+    format_overrides:
+      - goos: windows
+        format: zip
+    files:
+      - README.md
+checksum:
+  name_template: 'checksums.txt'
+snapshot:
+  name_template: "{{ incpatch .Version }}-next"
+changelog:
+  sort: asc
+  filters:
+    exclude:
+      - '^docs:'
+      - '^test:'

Dockerfile

@@ -0,0 +1,22 @@
+ARG GO_BUILDER=docker.io/library/golang:1.22
+ARG BASE_IMAGE=docker.io/library/alpine:3.12
+
+FROM ${GO_BUILDER} AS builder
+
+ARG VERSION
+ARG GOPROXY
+WORKDIR /workspace
+COPY . .
+
+RUN GOPROXY=${GOPROXY} go mod download
+RUN GOPROXY=${GOPROXY} CGO_ENABLED=0 go build -ldflags "-w -s -X github.com/linuxsuren/api-testing/pkg/version.version=${VERSION}\
+    -X github.com/linuxsuren/api-testing/pkg/version.date=$(date +%Y-%m-%d)" -o atest-store-iotdb .
+
+FROM ${BASE_IMAGE}
+
+LABEL org.opencontainers.image.source=https://github.com/LinuxSuRen/atest-ext-store-orm
+LABEL org.opencontainers.image.description="ORM database Store Extension of the API Testing."
+
+COPY --from=builder /workspace/atest-store-iotdb /usr/local/bin/atest-store-iotdb
+
+CMD [ "atest-store-iotdb" ]

Makefile

@@ -0,0 +1,19 @@
+fmt:
+	go mod tidy
+	go fmt ./...
+build:
+	go build -o bin/atest-store-iotdb .
+cp: build
+	cp bin/atest-store-iotdb ~/.config/atest/bin/
+test:
+	go test ./... -cover -v -coverprofile=coverage.out
+	go tool cover -func=coverage.out
+build-image:
+	docker build . -t e2e-extension
+hd:
+	curl https://linuxsuren.github.io/tools/install.sh|bash
+init-env: hd
+	hd i cli/cli
+	gh extension install linuxsuren/gh-dev
+run-e2e:
+	cd e2e && ./start.sh

cmd/root.go

@@ -0,0 +1,61 @@
+/*
+Copyright 2025 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 governing permissions and
+limitations under the License.
+*/
+package cmd
+
+import (
+	ext "github.com/linuxsuren/api-testing/pkg/extension"
+	"github.com/linuxsuren/api-testing/pkg/version"
+	"github.com/linuxsuren/atest-ext-store-iotdb/pkg"
+	"github.com/spf13/cobra"
+)
+
+func NewRootCommand() (c *cobra.Command) {
+	opt := &option{
+		Extension: ext.NewExtension("orm", "store", 7071),
+	}
+	c = &cobra.Command{
+		Use:   opt.GetFullName(),
+		Short: "Storage extension of api-testing",
+		RunE:  opt.runE,
+	}
+	opt.AddFlags(c.Flags())
+	c.Flags().IntVarP(&opt.historyLimit, "history-limit", "", 1000, "History record items count limit")
+	c.Flags().BoolVarP(&opt.version, "version", "", false, "Print the version then exit")
+	return
+}
+
+func (o *option) runE(c *cobra.Command, args []string) (err error) {
+	defer func() {
+		if r := recover(); r != nil {
+			c.Println(r)
+		}
+	}()
+
+	if o.version {
+		c.Println(version.GetVersion())
+		c.Println(version.GetDate())
+		return
+	}
+	remoteServer := pkg.NewRemoteServer(o.historyLimit)
+	err = ext.CreateRunner(o.Extension, c, remoteServer)
+	return
+}
+
+type option struct {
+	*ext.Extension
+	historyLimit int
+	version      bool
+}

cmd/root_test.go

@@ -0,0 +1,58 @@
+/*
+*
+MIT License
+
+Copyright (c) 2025 API Testing Authors.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+*/
+package cmd
+
+import (
+	"context"
+	"io"
+	"testing"
+	"time"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestRootCommand(t *testing.T) {
+	t.Run("invalid port", func(t *testing.T) {
+		c := NewRootCommand()
+		c.SetOut(io.Discard)
+		assert.Equal(t, "atest-store-orm", c.Use)
+
+		c.SetArgs([]string{"--port", "abc"})
+		err := c.Execute()
+		assert.Error(t, err)
+	})
+
+	t.Run("a random port", func(t *testing.T) {
+		ctx, cancel := context.WithTimeout(context.Background(), time.Second)
+		defer cancel()
+
+		c := NewRootCommand()
+		c.SetContext(ctx)
+
+		c.SetArgs([]string{"--port", "0"})
+		err := c.Execute()
+		assert.Error(t, err)
+	})
+}

e2e/Dockerfile

@@ -0,0 +1,8 @@
+FROM docker.io/library/e2e-extension as ext
+FROM ghcr.io/linuxsuren/api-testing:master
+
+WORKDIR /workspace
+COPY . .
+COPY --from=ext /usr/local/bin/atest-store-orm /usr/local/bin/atest-store-orm
+
+CMD [ "/workspace/entrypoint.sh" ]

e2e/compose.yaml

@@ -0,0 +1,41 @@
+version: '3.1'
+services:
+  testing:
+    build:
+      context: .
+      dockerfile: Dockerfile
+    depends_on:
+      iotdb:
+        condition: service_healthy
+      extension:
+        condition: service_started
+    volumes:
+      - type: volume
+        source: cache
+        target: /var/data
+    links:
+      - iotdb
+  extension:
+    build:
+      context: ..
+      dockerfile: Dockerfile
+      args:
+        - "GO_BUILDER=ghcr.io/linuxsuren/library/golang:1.22"
+        - "BASE_IMAGE=ghcr.io/linuxsuren/library/alpine:3.12"
+        - GOPROXY=${GOPROXY}
+
+  iotdb:
+    image: ghcr.io/linuxsuren/apache/iotdb:1.3.2-standalone
+    environment:
+      POSTGRES_USER: root
+      POSTGRES_PASSWORD: root
+      POSTGRES_DB: atest
+    healthcheck:
+      test: ["CMD", "bash", "-c", "cat < /dev/null > /dev/tcp/127.0.0.1/6667"]
+      interval: 3s
+      timeout: 30s
+      retries: 10
+    ports:
+      - 6667
+volumes:
+  cache:

e2e/entrypoint.sh

@@ -0,0 +1,13 @@
+#!/bin/bash
+set -e
+
+SCRIPT_DIR=$(dirname "$(readlink -f "$0")")
+mkdir -p /root/.config/atest
+mkdir -p /var/data
+
+echo "start to run server"
+nohup atest server&
+
+kind=iotdb target=iotdb driver=iotdb atest run -p testing-data-query.yaml
+
+cat /root/.config/atest/stores.yaml

e2e/start.sh

@@ -0,0 +1,11 @@
+#!/bin/bash
+
+file=$1
+if [ "$file" == "" ]
+then
+    file=compose.yaml
+fi
+
+docker compose version
+docker compose -f "$file" down
+docker compose -f "$file" up --build testing --exit-code-from testing --remove-orphans

e2e/testing-data-query.yaml

@@ -0,0 +1,60 @@
+#!api-testing
+# yaml-language-server: $schema=https://linuxsuren.github.io/api-testing/api-testing-schema.json
+name: atest
+api: |
+  {{default "http://localhost:8080" (env "SERVER")}}/api/v1
+param:
+  store: "{{randAlpha 3}}"
+  server: |
+    {{default "http://localhost:8080" (env "SERVER")}}
+items:
+- name: CreateStore
+  before:
+    items:
+      - httpReady("{{.param.server}}/healthz", 2400)
+  request:
+    api: /stores
+    method: POST
+    body: |
+      {
+        "name": "{{.param.store}}",
+        "url": "{{env "target"}}",
+        "username": "{{default "root" (env "username")}}",
+        "password": "{{default "root" (env "password")}}",
+        "kind": {
+          "name": "atest-store-{{env "kind"}}"
+        },
+        "properties": [{
+          "key": "driver",
+          "value": "{{default "mysql" (env "driver")}}"
+        }, {
+          "key": "database",
+          "value": "{{default "atest" (env "dbname")}}"
+        }, {
+          "key": "bucket",
+          "value": "bucket"
+        }, {
+          "key": "region",
+          "value": "cn"
+        }, {
+          "key": "disablessl",
+          "value": "true"
+        }, {
+          "key": "targetPath",
+          "value": "api-testing"
+        }]
+      }
+- name: query
+  before:
+    items:
+      - sleep(3)
+  request:
+    api: /data/query
+    method: POST
+    header:
+      X-Store-Name: "{{.param.store}}"
+    body: |
+      {
+        "sql": "",
+        "key": ""
+      }