搜尋
首頁後端開發GolangGolang 使用處理程序建立模擬資料庫並使用介面呼叫資料庫

Golang 使用处理程序创建模拟数据库并使用接口调用数据库

问题内容

我正在尝试对我的注册处理程序和数据库调用实施单元测试。但是,它在我的注册处理程序中的数据库调用上引发紧急错误。它是一个简单的注册处理程序,用于接收包含用户名、密码和电子邮件的 json。然后,我将使用 select 语句来检查该用户名是否在 signup 处理程序本身内重复。

当我向该处理程序发送我的发布请求时,这一切都有效。然而,当我实际进行单元测试时,它不起作用并给我抛出了两条错误消息。我觉得这是因为数据库没有在测试环境中初始化,但我不知道如何在不使用第三方框架进行模拟数据库的情况下做到这一点。

错误消息

panic: runtime error: invalid memory address or nil pointer dereference [recovered]
        panic: runtime error: invalid memory address or nil pointer dereference

signup.go

package handler

type signupjson struct {
    username string `json:"username"`
    password string `json:"password"`
    email    string `json:"email"`
}

func signup(w http.responsewriter, r *http.request) {
    // set headers
    w.header().set("content-type", "application/json")
    var newuser auth_management.signupjson

    // reading the request body and unmarshal the body to the loginjson struct
    bs, _ := io.readall(req.body)
    if err := json.unmarshal(bs, &newuser); err != nil {
        utils.responsejson(w, http.statusinternalservererror, "internal server error")
        log.println("internal server error in unmarshal json body in signup route:", err)
        return
    }

    ctx := context.background()
    ctx, cancel = context.withtimeout(ctx, time.minute * 2)
    defer cancel()

    // check if username already exists in database (duplicates not allowed)
    isexistingusername := database.getusername(ctx, newuser.username) // throws panic error here when testing
    if isexistingusername {
        utils.responsejson(w, http.statusbadrequest, "username has already been taken. please try again.")
        return
    }

    // other code logic...
}

sqlquery.go

package database

var sql_select_from_users = "select %s from users where %s = $1;"

func getusername(ctx context.context, username string) bool {
    row := conn.queryrow(ctx, fmt.sprintf(sql_select_from_users, "username", "username"), username)
    return row.scan() != pgx.errnorows
}

signup_test.go

package handler

func test_signup(t *testing.t) {

    var tests = []struct {
        name               string
        posteddata         signupjson
        expectedstatuscode int
    }{
        {
            name: "valid login",
            posteddata: signupjson{
                username: "testusername",
                password: "testpassword",
                email:    "[email protected]",
            },
            expectedstatuscode: 200,
        },
    }

    for _, e := range tests {
        jsonstr, err := json.marshal(e.posteddata)
        if err != nil {
            t.fatal(err)
        }

        // setting a request for testing
        req, _ := http.newrequest(http.methodpost, "/signup", strings.newreader(string(jsonstr)))
        req.header.set("content-type", "application/json")

        // setting and recording the response
        res := httptest.newrecorder()
        handler := http.handlerfunc(signup)

        handler.servehttp(res, req)

        if res.code != e.expectedstatuscode {
            t.errorf("%s: returned wrong status code; expected %d but got %d", e.name, e.expectedstatuscode, res.code)
        }
    }
}

setup_test.go

func TestMain(m *testing.M) {

    os.Exit(m.Run())
}

我在这里看到了一个类似的问题,但不确定这是否是正确的方法,因为没有响应,而且答案很混乱:how to write an unit test for a handler that invokes a function that invokes a function that intersted with db in golang using pgx 驱动程序?


正确答案


让我尝试帮助您弄清楚如何实现这些目标。我对你的代码进行了一些重构,但总体思路和使用的工具仍然与你的相同。首先,我将分享分为两个文件的生产代码:handlers/handlers.gorepo/repo.go

handlers/handlers.go 文件

package handlers

import (
    "context"
    "database/sql"
    "encoding/json"
    "io"
    "net/http"
    "time"

    "handlertest/repo"
)

type signupjson struct {
    username string `json:"username"`
    password string `json:"password"`
    email    string `json:"email"`
}

func signup(w http.responsewriter, r *http.request) {
    w.header().set("content-type", "application/json")

    var newuser signupjson
    bs, _ := io.readall(r.body)
    if err := json.unmarshal(bs, &newuser); err != nil {
        w.writeheader(http.statusbadrequest)
        w.write([]byte(err.error()))
        return
    }

    ctx, cancel := context.withtimeout(r.context(), time.minute*2)
    defer cancel()

    db, _ := ctx.value("db").(*sql.db)
    if isexistingusername := repo.getusername(ctx, db, newuser.username); isexistingusername {
        w.writeheader(http.statusbadrequest)
        w.write([]byte("username already present"))
        return
    }
    w.writeheader(http.statusok)
}

这里有两个主要区别:

  1. 使用的 context。您不必实例化另一个 ctx,只需使用与 http.request 一起提供的那个即可。
  2. 使用的 sql 客户端。正确的方法是通过context.context来传递。对于这种情况,您不必构建任何结构或使用任何接口等。只需编写一个需要 *sql.db 作为参数的函数即可。请记住这一点,函数是一等公民

当然,还有重构的空间。 "db" 应该是一个常量,我们必须检查上下文值中是否存在此条目,但为了简洁起见,我省略了这些检查。

repo/repo.go 文件

package repo

import (
    "context"
    "database/sql"

    "github.com/jackc/pgx/v5"
)

func getusername(ctx context.context, db *sql.db, username string) bool {
    row := db.queryrowcontext(ctx, "select username from users where username = $1", username)
    return row.scan() != pgx.errnorows
}

这里的代码与您的非常相似,除了以下两个小问题:

  1. 当您希望考虑上下文时,有一个名为 queryrowcontext 的专用方法。
  2. 当您必须构建 sql 查询时,请使用准备好的语句功能。不要将内容与 fmt.sprintf 连接起来,原因有两个:安全性和可测试性。

现在,我们要看看测试代码。

handlers/handlers_test.go 文件

package handlers

import (
    "context"
    "net/http"
    "net/http/httptest"
    "strings"
    "testing"

    "github.com/DATA-DOG/go-sqlmock"
    "github.com/jackc/pgx/v5"
    "github.com/stretchr/testify/assert"
)

func TestSignUp(t *testing.T) {
    db, mock, err := sqlmock.New(sqlmock.QueryMatcherOption(sqlmock.QueryMatcherEqual))
    if err != nil {
        t.Fatalf("err not expected while open a mock db, %v", err)
    }
    defer db.Close()
    t.Run("NewUser", func(t *testing.T) {
        mock.ExpectQuery("SELECT username FROM users WHERE username = $1").WithArgs("<a href="https://www.php.cn/link/89fee0513b6668e555959f5dc23238e9" class="__cf_email__" data-cfemail="ec86838482c2888389ac89948d819c8089c28f8381">[email&#160;protected]</a>").WillReturnError(pgx.ErrNoRows)

        w := httptest.NewRecorder()
        r := httptest.NewRequest(http.MethodPost, "/signup", strings.NewReader(`{"username": "<a href="https://www.php.cn/link/89fee0513b6668e555959f5dc23238e9" class="__cf_email__" data-cfemail="3c56535452125853597c59445d514c5059125f5351">[email&#160;protected]</a>", "password": "1234", "email": "<a href="https://www.php.cn/link/89fee0513b6668e555959f5dc23238e9" class="__cf_email__" data-cfemail="670d080f094903080227021f060a170b024904080a">[email&#160;protected]</a>"}`))

        ctx := context.WithValue(r.Context(), "DB", db)
        r = r.WithContext(ctx)

        SignUp(w, r)

        assert.Equal(t, http.StatusOK, w.Code)
        if err := mock.ExpectationsWereMet(); err != nil {
            t.Errorf("not all expectations were met: %v", err)
        }
    })

    t.Run("AlreadyExistentUser", func(t *testing.T) {
        rows := sqlmock.NewRows([]string{"username"}).AddRow("<a href="https://www.php.cn/link/89fee0513b6668e555959f5dc23238e9" class="__cf_email__" data-cfemail="9df7f2f5f3b3f9f2f8ddf8e5fcf0edf1f8b3fef2f0">[email&#160;protected]</a>")
        mock.ExpectQuery("SELECT username FROM users WHERE username = $1").WithArgs("<a href="https://www.php.cn/link/89fee0513b6668e555959f5dc23238e9" class="__cf_email__" data-cfemail="107a7f787e3e747f75507568717d607c753e737f7d">[email&#160;protected]</a>").WillReturnRows(rows)

        w := httptest.NewRecorder()
        r := httptest.NewRequest(http.MethodPost, "/signup", strings.NewReader(`{"username": "<a href="https://www.php.cn/link/89fee0513b6668e555959f5dc23238e9" class="__cf_email__" data-cfemail="33595c5b5d1d575c5673564b525e435f561d505c5e">[email&#160;protected]</a>", "password": "1234", "email": "<a href="https://www.php.cn/link/89fee0513b6668e555959f5dc23238e9" class="__cf_email__" data-cfemail="a3c9cccbcd8dc7ccc6e3c6dbc2ced3cfc68dc0ccce">[email&#160;protected]</a>"}`))

        ctx := context.WithValue(r.Context(), "DB", db)
        r = r.WithContext(ctx)

        SignUp(w, r)

        assert.Equal(t, http.StatusBadRequest, w.Code)
        if err := mock.ExpectationsWereMet(); err != nil {
            t.Errorf("not all expectations were met: %v", err)
        }
    })
}

这里,与您的版本相比有很多变化。让我快速回顾一下:

  • 使用子测试功能为测试提供层次结构。
  • 使用 httptest 包,它提供了用于构建和断言 http 请求和响应的内容。
  • 使用 sqlmock 包。模拟数据库的事实上的标准。
  • 使用 context 传递 sql 客户端以及 http.request
  • 已使用 github.com/stretchr/testify/assert 包完成断言。

这同样适用于这里:有重构的空间(例如,您可以使用表驱动测试功能重新设计测试)。

片尾

这可以被认为是编写 go 代码的惯用方式。我知道这可能非常具有挑战性,尤其是在一开始。如果您需要有关某些部分的更多详细信息,请告诉我,我将很乐意为您提供帮助,谢谢!

以上是Golang 使用處理程序建立模擬資料庫並使用介面呼叫資料庫的詳細內容。更多資訊請關注PHP中文網其他相關文章!

陳述
本文轉載於:stackoverflow。如有侵權,請聯絡admin@php.cn刪除
Go語言包導入:帶下劃線和不帶下劃線的區別是什麼?Go語言包導入:帶下劃線和不帶下劃線的區別是什麼?Mar 03, 2025 pm 05:17 PM

本文解釋了GO的軟件包導入機制:命名imports(例如導入“ fmt”)和空白導入(例如導入_ fmt; fmt;)。 命名導入使包裝內容可訪問,而空白導入僅執行t

Beego框架中NewFlash()函數如何實現頁面間短暫信息傳遞?Beego框架中NewFlash()函數如何實現頁面間短暫信息傳遞?Mar 03, 2025 pm 05:22 PM

本文解釋了Beego的NewFlash()函數,用於Web應用程序中的頁間數據傳輸。 它專注於使用newflash()在控制器之間顯示臨時消息(成功,錯誤,警告),並利用會話機制。 Lima

Go語言中如何將MySQL查詢結果List轉換為自定義結構體切片?Go語言中如何將MySQL查詢結果List轉換為自定義結構體切片?Mar 03, 2025 pm 05:18 PM

本文詳細介紹了MySQL查詢結果的有效轉換為GO結構切片。 它強調使用數據庫/SQL的掃描方法來最佳性能,避免手動解析。 使用DB標籤和Robus的結構現場映射的最佳實踐

如何編寫模擬對象和存根以進行測試?如何編寫模擬對象和存根以進行測試?Mar 10, 2025 pm 05:38 PM

本文演示了創建模擬和存根進行單元測試。 它強調使用接口,提供模擬實現的示例,並討論最佳實踐,例如保持模擬集中並使用斷言庫。 文章

如何定義GO中仿製藥的自定義類型約束?如何定義GO中仿製藥的自定義類型約束?Mar 10, 2025 pm 03:20 PM

本文探討了GO的仿製藥自定義類型約束。 它詳細介紹了界面如何定義通用功能的最低類型要求,從而改善了類型的安全性和代碼可重複使用性。 本文還討論了局限性和最佳實踐

Go語言如何便捷地寫入文件?Go語言如何便捷地寫入文件?Mar 03, 2025 pm 05:15 PM

本文詳細介紹了在GO中詳細介紹有效的文件,將OS.WriteFile(適用於小文件)與OS.openfile和緩衝寫入(最佳大型文件)進行比較。 它強調了使用延遲並檢查特定錯誤的可靠錯誤處理。

您如何在GO中編寫單元測試?您如何在GO中編寫單元測試?Mar 21, 2025 pm 06:34 PM

本文討論了GO中的編寫單元測試,涵蓋了最佳實踐,模擬技術和有效測試管理的工具。

如何使用跟踪工具了解GO應用程序的執行流?如何使用跟踪工具了解GO應用程序的執行流?Mar 10, 2025 pm 05:36 PM

本文使用跟踪工具探討了GO應用程序執行流。 它討論了手冊和自動儀器技術,比較諸如Jaeger,Zipkin和Opentelemetry之類的工具,並突出顯示有效的數據可視化

See all articles

熱AI工具

Undresser.AI Undress

Undresser.AI Undress

人工智慧驅動的應用程序,用於創建逼真的裸體照片

AI Clothes Remover

AI Clothes Remover

用於從照片中去除衣服的線上人工智慧工具。

Undress AI Tool

Undress AI Tool

免費脫衣圖片

Clothoff.io

Clothoff.io

AI脫衣器

AI Hentai Generator

AI Hentai Generator

免費產生 AI 無盡。

熱門文章

R.E.P.O.能量晶體解釋及其做什麼(黃色晶體)
2 週前By尊渡假赌尊渡假赌尊渡假赌
倉庫:如何復興隊友
4 週前By尊渡假赌尊渡假赌尊渡假赌
Hello Kitty Island冒險:如何獲得巨型種子
4 週前By尊渡假赌尊渡假赌尊渡假赌

熱工具

Safe Exam Browser

Safe Exam Browser

Safe Exam Browser是一個安全的瀏覽器環境,安全地進行線上考試。該軟體將任何電腦變成一個安全的工作站。它控制對任何實用工具的訪問,並防止學生使用未經授權的資源。

DVWA

DVWA

Damn Vulnerable Web App (DVWA) 是一個PHP/MySQL的Web應用程序,非常容易受到攻擊。它的主要目標是成為安全專業人員在合法環境中測試自己的技能和工具的輔助工具,幫助Web開發人員更好地理解保護網路應用程式的過程,並幫助教師/學生在課堂環境中教授/學習Web應用程式安全性。 DVWA的目標是透過簡單直接的介面練習一些最常見的Web漏洞,難度各不相同。請注意,該軟體中

SublimeText3 英文版

SublimeText3 英文版

推薦:為Win版本,支援程式碼提示!

EditPlus 中文破解版

EditPlus 中文破解版

體積小,語法高亮,不支援程式碼提示功能

SublimeText3 Linux新版

SublimeText3 Linux新版

SublimeText3 Linux最新版