草庐IT

api - GO单元测试结构化REST API项目

coder 2023-06-30 原文

我正在尝试为我已经创建的 REST API 编写不错单元测试。我有这个简单的结构:

ROOT/
    config/
    handlers/
    lib/
    models/
    router/
    main.go

config 包含 JSON 格式的配置和一个简单的 config.go，它读取和解析 JSON 文件并填充 Config 结构。 handlers 包含 controllers(即 router/routes.go 中描述的相应 METHOD+URL 的处理程序)。 lib 包含一些数据库、请求响应器和记录器逻辑。 models 包含要从 JSON 和 DB 映射到的结构及其函数。最后 router 包含路由器和路由定义。

现在我正在搜索和阅读很多关于在 GO 中对 REST API 进行单元测试的文章，并找到了关于如何设置测试服务器、定义路由和测试我的请求的或多或少令人满意的文章。一切都很好。 但仅当您想要测试单个文件时!

我现在的问题是如何为所有处理程序设置测试环境(服务器、路由、数据库连接)？用找到的方法here (我发现这很容易理解和实现)我有一个问题:我必须为每个处理程序单独运行测试，或者我必须在一个测试中为所有处理程序编写测试套件文件。我相信你明白这两种情况都不是很高兴(第一种是因为我需要保留运行 go test 运行所有成功的测试，第二种是因为拥有一个测试文件来覆盖所有处理程序函数将变得无法维护) .

到目前为止，我已经成功了(根据 the linked article )只有当我将所有测试和初始化代码放入每个 XYZhandler_test.go 文件的一个 func 时，但我也不喜欢这种方法.

我想要实现的是一种 setUp() 或 init() 运行一次，第一次触发测试使所有必需的变量全局可见并初始化，以便所有接下来的测试都可以使用它们，而无需再次实例化它们，同时确保此设置文件仅为测试编译...

我不确定这是否完全清楚，或者这类问题是否需要一些代码示例(除了 already linked in the article，但我会添加您认为需要的任何内容，请告诉我!

最佳答案

测试包，而不是文件!

由于您正在测试处理程序/端点，因此将所有 _test 文件放在处理程序或路由器包中是有意义的。 (例如，每个端点/处理程序一个文件)。

此外，不要使用 init() 来设置您的测试。 testing包指定具有以下签名的函数:

func TestMain(m *testing.M)

The generated test will call TestMain(m) instead of running the tests directly. TestMain runs in the main goroutine and can do whatever setup and teardown is necessary around a call to m.Run. It should then call os.Exit with the result of m.Run

在 TestMain 函数中，您可以进行任何需要的设置以运行测试。如果你有全局变量，这是声明和初始化它们的地方。您只需要为每个包执行一次此操作，因此将 TestMain 代码放在单独的 _test 文件中是有意义的。例如:

package router

import (
    "testing"
    "net/http/httptest"
) 

var (
    testServer *httptest.Server
)

func TestMain(m *testing.M)  {
    // setup the test server
    router := ConfigureRouter()
    testServer = httptest.NewServer(router)

    // run tests
    os.Exit(m.Run())
}

最后使用 go test my/package/router 运行测试。

关于api - GO单元测试结构化REST API项目，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/36177614/

结构化RESTcodesectiontestingapiunit-testinggo

有关api - GO单元测试结构化REST API项目的更多相关文章

  1. ruby-on-rails - 使用 Ruby on Rails 进行自动化测试 - 最佳实践 - 2

    很好奇，就使用ruby​​onrails自动化单元测试而言，你们正在做什么？您是否创建了一个脚本来在cron中运行rake作业并将结果邮寄给您？git中的预提交Hook？只是手动调用？我完全理解测试，但想知道在错误发生之前捕获错误的最佳实践是什么。让我们理所当然地认为测试本身是完美无缺的，并且可以正常工作。下一步是什么以确保他们在正确的时间将可能有害的结果传达给您？ 最佳答案 不确定您到底想听什么，但是有几个级别的自动代码库控制:在处理某项功能时，您可以使用类似autotest的内容获得关于哪些有效，哪些无效的即时反馈。要确保您的提

  2. ruby - 使用 ruby​​ 将 HTML 转换为纯文本并维护结构/格式 - 2

    我想将html转换为纯文本。不过，我不想只删除标签，我想智能地保留尽可能多的格式。为插入换行符标签，检测段落并格式化它们等。输入非常简单，通常是格式良好的html(不是整个文档，只是一堆内容，通常没有anchor或图像)。我可以将几个正则表达式放在一起，让我达到80%，但我认为可能有一些现有的解决方案更智能。 最佳答案 首先，不要尝试为此使用正则表达式。很有可能你会想出一个脆弱/脆弱的解决方案，它会随着HTML的变化而崩溃，或者很难管理和维护。您可以使用Nokogiri快速解析HTML并提取文本:require'nokogiri'h

  3. ruby - 使用 C 扩展开发 ruby​​gem 时，如何使用 Rspec 在本地进行测试？ - 2

    我正在编写一个包含C扩展的gem。通常当我写一个gem时，我会遵循TDD的过程，我会写一个失败的规范，然后处理代码直到它通过，等等......在“ext/mygem/mygem.c”中我的C扩展和在gemspec的“扩展”中配置的有效extconf.rb，如何运行我的规范并仍然加载我的C扩展？当我更改C代码时，我需要采取哪些步骤来重新编译代码？这可能是个愚蠢的问题，但是从我的gem的开发源代码树中输入“bundleinstall”不会构建任何native扩展。当我手动运行rubyext/mygem/extconf.rb时，我确实得到了一个Makefile(在整个项目的根目录中)，然后当

  4. ruby - Ruby 的 Hash 在比较键时使用哪种相等性测试？ - 2

    我有一个围绕一些对象的包装类，我想将这些对象用作散列中的键。包装对象和解包装对象应映射到相同的键。一个简单的例子是这样的:classAattr_reader:xdefinitialize(inner)@inner=innerenddefx;@inner.x;enddef==(other)@inner.x==other.xendenda=A.new(o)#oisjustanyobjectthatallowso.xb=A.new(o)h={a=>5}ph[a]#5ph[b]#nil,shouldbe5ph[o]#nil,shouldbe5我试过==、===、eq?并散列所有无济于事。

  5. ruby - RSpec - 使用测试替身作为 block 参数 - 2

    我有一些Ruby代码，如下所示:Something.createdo|x|x.foo=barend我想编写一个测试，它使用double代替block参数x，这样我就可以调用:x_double.should_receive(:foo).with("whatever").这可能吗？ 最佳答案 specify'something'dox=doublex.should_receive(:foo=).with("whatever")Something.should_receive(:create).and_yield(x)#callthere

  6. ruby - Sinatra:运行 rspec 测试时记录噪音 - 2

    Sinatra新手；我正在运行一些rspec测试，但在日志中收到了一堆不需要的噪音。如何消除日志中过多的噪音？我仔细检查了环境是否设置为:test，这意味着记录器级别应设置为WARN而不是DEBUG。spec_helper:require"./app"require"sinatra"require"rspec"require"rack/test"require"database_cleaner"require"factory_girl"set:environment,:testFactoryGirl.definition_file_paths=%w{./factories./test/

  7. ruby-on-rails - 迷你测试错误 : "NameError: uninitialized constant" - 2

    我遵循MichaelHartl的“RubyonRails教程:学习Web开发”，并创建了检查用户名和电子邮件长度有效性的测试(名称最多50个字符，电子邮件最多255个字符)。test/helpers/application_helper_test.rb的内容是:require'test_helper'classApplicationHelperTest在运行bundleexecraketest时，所有测试都通过了，但我看到以下消息在最后被标记为错误:ERROR["test_full_title_helper",ApplicationHelperTest,1.820016791]test

  8. ruby - 即使失败也继续进行多主机测试 - 2

    我已经构建了一些serverspec代码来在多个主机上运行一组测试。问题是当任何测试失败时，测试会在当前主机停止。即使测试失败，我也希望它继续在所有主机上运行。Rakefile:namespace:specdotask:all=>hosts.map{|h|'spec:'+h.split('.')[0]}hosts.eachdo|host|begindesc"Runserverspecto#{host}"RSpec::Core::RakeTask.new(host)do|t|ENV['TARGET_HOST']=hostt.pattern="spec/cfengine3/*_spec.r

  9. ruby-on-rails - 如何使辅助方法在 Rails 集成测试中可用？ - 2

    我在app/helpers/sessions_helper.rb中有一个帮助程序文件，其中包含一个方法my_preference，它返回当前登录用户的首选项。我想在集成测试中访问该方法。例如，这样我就可以在测试中使用getuser_path(my_preference)。在其他帖子中，我读到这可以通过在测试文件中包含requiresessions_helper来实现，但我仍然收到错误NameError:undefinedlocalvariableormethod'my_preference'.我做错了什么？require'test_helper'require'sessions_hel

  10. ruby-on-rails - ActionController::RoutingError: 未初始化常量 Api::V1::ApiController - 2

    我有用于控制用户任务的Rails5API项目，我有以下错误，但并非总是针对相同的Controller和路由。ActionController::RoutingError:uninitializedconstantApi::V1::ApiController我向您描述了一些我的项目，以更详细地解释错误。应用结构路线scopemodule:'api'donamespace:v1do#=>Loginroutesscopemodule:'login'domatch'login',to:'sessions#login',as:'login',via::postend#=>Teamroutessc

随机推荐