目錄
正确答案
handlers/handlers.go 文件
repo/repo.go 文件
handlers/handlers_test.go 文件
片尾
首頁 後端開發 Golang Golang 使用處理程序建立模擬資料庫並使用介面呼叫資料庫

Golang 使用處理程序建立模擬資料庫並使用介面呼叫資料庫

Feb 06, 2024 am 08:42 AM

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中文網其他相關文章!

本網站聲明
本文內容由網友自願投稿,版權歸原作者所有。本站不承擔相應的法律責任。如發現涉嫌抄襲或侵權的內容,請聯絡admin@php.cn

熱AI工具

Undresser.AI Undress

Undresser.AI Undress

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

AI Clothes Remover

AI Clothes Remover

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

Undress AI Tool

Undress AI Tool

免費脫衣圖片

Clothoff.io

Clothoff.io

AI脫衣器

Video Face Swap

Video Face Swap

使用我們完全免費的人工智慧換臉工具,輕鬆在任何影片中換臉!

熱工具

記事本++7.3.1

記事本++7.3.1

好用且免費的程式碼編輯器

SublimeText3漢化版

SublimeText3漢化版

中文版,非常好用

禪工作室 13.0.1

禪工作室 13.0.1

強大的PHP整合開發環境

Dreamweaver CS6

Dreamweaver CS6

視覺化網頁開發工具

SublimeText3 Mac版

SublimeText3 Mac版

神級程式碼編輯軟體(SublimeText3)

Debian OpenSSL有哪些漏洞 Debian OpenSSL有哪些漏洞 Apr 02, 2025 am 07:30 AM

OpenSSL,作為廣泛應用於安全通信的開源庫,提供了加密算法、密鑰和證書管理等功能。然而,其歷史版本中存在一些已知安全漏洞,其中一些危害極大。本文將重點介紹Debian系統中OpenSSL的常見漏洞及應對措施。 DebianOpenSSL已知漏洞:OpenSSL曾出現過多個嚴重漏洞,例如:心臟出血漏洞(CVE-2014-0160):該漏洞影響OpenSSL1.0.1至1.0.1f以及1.0.2至1.0.2beta版本。攻擊者可利用此漏洞未經授權讀取服務器上的敏感信息,包括加密密鑰等。

從前端轉型後端開發,學習Java還是Golang更有前景? 從前端轉型後端開發,學習Java還是Golang更有前景? Apr 02, 2025 am 09:12 AM

後端學習路徑:從前端轉型到後端的探索之旅作為一名從前端開發轉型的後端初學者,你已經有了nodejs的基礎,...

Go語言中用於浮點數運算的庫有哪些? Go語言中用於浮點數運算的庫有哪些? Apr 02, 2025 pm 02:06 PM

Go語言中用於浮點數運算的庫介紹在Go語言(也稱為Golang)中,進行浮點數的加減乘除運算時,如何確保精度是�...

Go的爬蟲Colly中Queue線程的問題是什麼? Go的爬蟲Colly中Queue線程的問題是什麼? Apr 02, 2025 pm 02:09 PM

Go爬蟲Colly中的Queue線程問題探討在使用Go語言的Colly爬蟲庫時,開發者常常會遇到關於線程和請求隊列的問題。 �...

Beego ORM中如何指定模型關聯的數據庫? Beego ORM中如何指定模型關聯的數據庫? Apr 02, 2025 pm 03:54 PM

在BeegoORM框架下,如何指定模型關聯的數據庫?許多Beego項目需要同時操作多個數據庫。當使用Beego...

在 Go 語言中,為什麼使用 Println 和 string() 函數打印字符串會出現不同的效果? 在 Go 語言中,為什麼使用 Println 和 string() 函數打印字符串會出現不同的效果? Apr 02, 2025 pm 02:03 PM

Go語言中字符串打印的區別:使用Println與string()函數的效果差異在Go...

在Go語言中使用Redis Stream實現消息隊列時,如何解決user_id類型轉換問題? 在Go語言中使用Redis Stream實現消息隊列時,如何解決user_id類型轉換問題? Apr 02, 2025 pm 04:54 PM

Go語言中使用RedisStream實現消息隊列時類型轉換問題在使用Go語言與Redis...

GoLand中自定義結構體標籤不顯示怎麼辦? GoLand中自定義結構體標籤不顯示怎麼辦? Apr 02, 2025 pm 05:09 PM

GoLand中自定義結構體標籤不顯示怎麼辦?在使用GoLand進行Go語言開發時,很多開發者會遇到自定義結構體標籤在�...

See all articles