Table of Contents
正确答案
handlers/handlers.go 文件
repo/repo.go 文件
handlers/handlers_test.go 文件
片尾
Home Backend Development Golang Golang uses handlers to create mock databases and uses interfaces to call the database

Golang uses handlers to create mock databases and uses interfaces to call the database

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
Copy after login

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...
}
Copy after login

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
}
Copy after login

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)
        }
    }
}
Copy after login

setup_test.go

func TestMain(m *testing.M) {

    os.Exit(m.Run())
}

Copy after login

我在这里看到了一个类似的问题,但不确定这是否是正确的方法,因为没有响应,而且答案很混乱: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)
}
Copy after login

这里有两个主要区别:

  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
}
Copy after login

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

  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)
        }
    })
}
Copy after login

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

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

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

片尾

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

The above is the detailed content of Golang uses handlers to create mock databases and uses interfaces to call the database. For more information, please follow other related articles on the PHP Chinese website!

Statement of this Website
The content of this article is voluntarily contributed by netizens, and the copyright belongs to the original author. This site does not assume corresponding legal responsibility. If you find any content suspected of plagiarism or infringement, please contact admin@php.cn

Hot AI Tools

Undresser.AI Undress

Undresser.AI Undress

AI-powered app for creating realistic nude photos

AI Clothes Remover

AI Clothes Remover

Online AI tool for removing clothes from photos.

Undress AI Tool

Undress AI Tool

Undress images for free

Clothoff.io

Clothoff.io

AI clothes remover

Video Face Swap

Video Face Swap

Swap faces in any video effortlessly with our completely free AI face swap tool!

Hot Tools

Notepad++7.3.1

Notepad++7.3.1

Easy-to-use and free code editor

SublimeText3 Chinese version

SublimeText3 Chinese version

Chinese version, very easy to use

Zend Studio 13.0.1

Zend Studio 13.0.1

Powerful PHP integrated development environment

Dreamweaver CS6

Dreamweaver CS6

Visual web development tools

SublimeText3 Mac version

SublimeText3 Mac version

God-level code editing software (SublimeText3)

What are the vulnerabilities of Debian OpenSSL What are the vulnerabilities of Debian OpenSSL Apr 02, 2025 am 07:30 AM

OpenSSL, as an open source library widely used in secure communications, provides encryption algorithms, keys and certificate management functions. However, there are some known security vulnerabilities in its historical version, some of which are extremely harmful. This article will focus on common vulnerabilities and response measures for OpenSSL in Debian systems. DebianOpenSSL known vulnerabilities: OpenSSL has experienced several serious vulnerabilities, such as: Heart Bleeding Vulnerability (CVE-2014-0160): This vulnerability affects OpenSSL 1.0.1 to 1.0.1f and 1.0.2 to 1.0.2 beta versions. An attacker can use this vulnerability to unauthorized read sensitive information on the server, including encryption keys, etc.

What libraries are used for floating point number operations in Go? What libraries are used for floating point number operations in Go? Apr 02, 2025 pm 02:06 PM

The library used for floating-point number operation in Go language introduces how to ensure the accuracy is...

What is the problem with Queue thread in Go's crawler Colly? What is the problem with Queue thread in Go's crawler Colly? Apr 02, 2025 pm 02:09 PM

Queue threading problem in Go crawler Colly explores the problem of using the Colly crawler library in Go language, developers often encounter problems with threads and request queues. �...

Transforming from front-end to back-end development, is it more promising to learn Java or Golang? Transforming from front-end to back-end development, is it more promising to learn Java or Golang? Apr 02, 2025 am 09:12 AM

Backend learning path: The exploration journey from front-end to back-end As a back-end beginner who transforms from front-end development, you already have the foundation of nodejs,...

In Go, why does printing strings with Println and string() functions have different effects? In Go, why does printing strings with Println and string() functions have different effects? Apr 02, 2025 pm 02:03 PM

The difference between string printing in Go language: The difference in the effect of using Println and string() functions is in Go...

PostgreSQL monitoring method under Debian PostgreSQL monitoring method under Debian Apr 02, 2025 am 07:27 AM

This article introduces a variety of methods and tools to monitor PostgreSQL databases under the Debian system, helping you to fully grasp database performance monitoring. 1. Use PostgreSQL to build-in monitoring view PostgreSQL itself provides multiple views for monitoring database activities: pg_stat_activity: displays database activities in real time, including connections, queries, transactions and other information. pg_stat_replication: Monitors replication status, especially suitable for stream replication clusters. pg_stat_database: Provides database statistics, such as database size, transaction commit/rollback times and other key indicators. 2. Use log analysis tool pgBadg

How to specify the database associated with the model in Beego ORM? How to specify the database associated with the model in Beego ORM? Apr 02, 2025 pm 03:54 PM

Under the BeegoORM framework, how to specify the database associated with the model? Many Beego projects require multiple databases to be operated simultaneously. When using Beego...

How to solve the user_id type conversion problem when using Redis Stream to implement message queues in Go language? How to solve the user_id type conversion problem when using Redis Stream to implement message queues in Go language? Apr 02, 2025 pm 04:54 PM

The problem of using RedisStream to implement message queues in Go language is using Go language and Redis...

See all articles