草庐IT

java - 如何从 TDD 开始 RESTful api

coder 2024-03-13 原文

我正在尝试练习 TDD，并且有一个练习要做。 互联网某处部署了一项现有服务，具有公共(public) RESTful api。 对此 api 的每个请求都需要一些数据准备，例如有效的请求字符串构造、一些加密、一些正文消息格式等。 我想使用 TDD 为这项服务编写通用客户端。

我知道这并不像例如StringCalculator kata，并且需要一些不同的方法。

我不知道如何开始。我想在不使用真实服务的情况下对其进行测试，因此需要某种虚假的暗示。编写一些伪造的实现，将其部署在本地主机上并从我的测试中调用它是否更好？或者模拟一个负责发送 http 请求的类？

我希望我的客户端用法如下:

public class ServiceClientTest {
   @Test
   public void testSendStoreRequest() {
        ServiceClient client = new ServiceClient("app_key", "private_key")
        ClientResponse response = client.sendStoreRequest(StorageType.NORMAL,     "string_to_store");
       assertEquals("200", response.getStatus());
   } 
}

你能给我指明如何开始的方向吗？ 我应该自下而上并编写所有组件(用于请求字符串创建、加密等)然后在 ServiceClient 中使用它们，还是应该从 ServiceClient 测试和实现开始自上而下和模拟？

最佳答案

First of all , don't mock external APIs .为什么？ Cos you don't own them .

您的问题的理想解决方案似乎就是您开始描述的内容。您应该在您的项目中创建一个您拥有的接口(interface)，它将代表外部服务。

public interface CalculatorService {
    int add(int a, int b);
}

这将是您用于测试的边界。您所有的 UNIT 和 ACCEPTANCE 测试都应该针对 CalculatorService 的模拟或 stub 运行。他们会很快。 您可以这样做，因为是您定义了该契约(Contract)(该接口(interface)的实际含义)。

稍后，您将有一个用于该远程 HTTP rest 服务的实现:

class RemoteRestCalculator implements CalculatorService {
    public int add(int a, int b) {
        // call the remote service in here
    }
}

你需要测试这个契约(Contract)(边框)。因此，您将为 RemoteRestCalculator 编写集成测试。您还可以进行一些端到端测试，使用 RemoteRestCalculator 运行应用程序以测试接线等。

现在，回答你的问题，如何测试 RemoteRestCalculator？

  1. 理想情况下，您会在测试环境中部署一个真正的 http rest 服务实例，将其指向测试数据库等。因此，您与拥有该服务的人员交谈，他们会为您提供使用 *.war 文件，然后使用测试数据库等将其部署到本地。有时他们会为您完成该服务的“沙盒”部署。。 然后您为针对该实例运行的 RemoteRestCalculator 编写测试。
  2. 另一个解决方案与您提到的类似。创建一个“http rest 服务模拟器”。然后部署到本地。 诀窍在于您必须为您在该模拟器中使用的所有功能复制真实的服务行为。因此，模拟器的“添加”方法必须与真实方法的行为相同。这个解决方案有很多优点和缺点。 然后您为针对该模拟器运行的 RemoteRestCalculator 编写测试。
  3. 有一种中间解决方案在行业中被广泛使用。您只需针对真实服务(或有时是模拟器)的本地测试部署运行所有测试。 不幸的是，在这种情况下，当您有很多测试时，测试套件可能会非常慢。不推荐。 Further reading about making builds go faster .
  4. 还有一种常用的解决方案，在大多数情况下不推荐使用。您创建了一个“http rest stub 类”，它的使用有点像 mockito mock，但它总是通过 http 进行通信。所以通常它会启动一个 http 服务器，你会在使用它之前准备好它。它的缺点比优点多得多。最大的缺点是服务的行为(外部依赖)分散在应用程序的许多测试中。 不推荐。

关于java - 如何从 TDD 开始 RESTful api，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/7791125/

RESTfuljavastrongcodeRemoteRestCalculatortdd

有关java - 如何从 TDD 开始 RESTful api的更多相关文章

  1. ruby - 如何使用 Nokogiri 的 xpath 和 at_xpath 方法 - 2

    我正在学习如何使用Nokogiri，根据这段代码我遇到了一些问题:require'rubygems'require'mechanize'post_agent=WWW::Mechanize.newpost_page=post_agent.get('http://www.vbulletin.org/forum/showthread.php?t=230708')puts"\nabsolutepathwithtbodygivesnil"putspost_page.parser.xpath('/html/body/div/div/div/div/div/table/tbody/tr/td/div

  2. ruby - 如何从 ruby​​ 中的字符串运行任意对象方法？ - 2

    总的来说，我对ruby​​还比较陌生，我正在为我正在创建的对象编写一些rspec测试用例。许多测试用例都非常基础，我只是想确保正确填充和返回值。我想知道是否有办法使用循环结构来执行此操作。不必为我要测试的每个方法都设置一个assertEquals。例如:describeitem,"TestingtheItem"doit"willhaveanullvaluetostart"doitem=Item.new#HereIcoulddotheitem.name.shouldbe_nil#thenIcoulddoitem.category.shouldbe_nilendend但我想要一些方法来使用

  3. python - 如何使用 Ruby 或 Python 创建一系列高音调和低音调的蜂鸣声？ - 2

    关闭。这个问题是opinion-based.它目前不接受答案。想要改进这个问题？更新问题，以便editingthispost可以用事实和引用来回答它.关闭4年前。Improvethisquestion我想在固定时间创建一系列低音和高音调的哔哔声。例如:在150毫秒时发出高音调的蜂鸣声在151毫秒时发出低音调的蜂鸣声200毫秒时发出低音调的蜂鸣声250毫秒的高音调蜂鸣声有没有办法在Ruby或Python中做到这一点？我真的不在乎输出编码是什么(.wav、.mp3、.ogg等等)，但我确实想创建一个输出文件。

  4. ruby-on-rails - 如何验证 update_all 是否实际在 Rails 中更新 - 2

    给定这段代码defcreate@upgrades=User.update_all(["role=?","upgraded"],:id=>params[:upgrade])redirect_toadmin_upgrades_path,:notice=>"Successfullyupgradeduser."end我如何在该操作中实际验证它们是否已保存或未重定向到适当的页面和消息？ 最佳答案 在Rails3中，update_all不返回任何有意义的信息，除了已更新的记录数(这可能取决于您的DBMS是否返回该信息)。http://ar.ru

  5. ruby-on-rails - 'compass watch' 是如何工作的/它是如何与 rails 一起使用的 - 2

    我在我的项目目录中完成了compasscreate.和compassinitrails。几个问题:我已将我的.sass文件放在public/stylesheets中。这是放置它们的正确位置吗？当我运行compasswatch时，它不会自动编译这些.sass文件。我必须手动指定文件:compasswatchpublic/stylesheets/myfile.sass等。如何让它自动运行？文件ie.css、print.css和screen.css已放在stylesheets/compiled。如何在编译后不让它们重新出现的情况下删除它们？我自己编译的.sass文件编译成compiled/t

  6. ruby - 如何将脚本文件的末尾读取为数据文件(Perl 或任何其他语言) - 2

    我正在寻找执行以下操作的正确语法(在Perl、Shell或Ruby中):#variabletoaccessthedatalinesappendedasafileEND_OF_SCRIPT_MARKERrawdatastartshereanditcontinues. 最佳答案 Perl用__DATA__做这个:#!/usr/bin/perlusestrict;usewarnings;while(){print;}__DATA__Texttoprintgoeshere 关于ruby-如何将脚

  7. ruby - 如何指定 Rack 处理程序 - 2

    Rackup通过Rack的默认处理程序成功运行任何Rack应用程序。例如:classRackAppdefcall(environment)['200',{'Content-Type'=>'text/html'},["Helloworld"]]endendrunRackApp.new但是当最后一行更改为使用Rack的内置CGI处理程序时，rackup给出“NoMethodErrorat/undefinedmethod`call'fornil:NilClass”:Rack::Handler::CGI.runRackApp.newRack的其他内置处理程序也提出了同样的反对意见。例如Rack

  8. ruby - 如何每月在 Heroku 运行一次 Scheduler 插件？ - 2

    在选择我想要运行操作的频率时，唯一的选项是“每天”、“每小时”和“每10分钟”。谢谢!我想为我的Rails3.1应用程序运行调度程序。 最佳答案 这不是一个优雅的解决方案，但您可以安排它每天运行，并在实际开始工作之前检查日期是否为当月的第一天。 关于ruby-如何每月在Heroku运行一次Scheduler插件？，我们在StackOverflow上找到一个类似的问题： https://stackoverflow.com/questions/8692687/

  9. ruby-on-rails - 如何从 format.xml 中删除 <hash></hash> - 2

    我有一个对象has_many应呈现为xml的子对象。这不是问题。我的问题是我创建了一个Hash包含此数据，就像解析器需要它一样。但是rails自动将整个文件包含在.........我需要摆脱type="array"和我该如何处理？我没有在文档中找到任何内容。 最佳答案 我遇到了同样的问题；这是我的XML:我在用这个:entries.to_xml将散列数据转换为XML，但这会将条目的数据包装到中所以我修改了:entries.to_xml(root:"Contacts")但这仍然将转换后的XML包装在“联系人”中，将我的XML代码修改为

  10. ruby - 如何使用文字标量样式在 YAML 中转储字符串？ - 2

    我有一大串格式化数据(例如JSON)，我想使用Psychinruby​​同时保留格式转储到YAML。基本上，我希望JSON使用literalstyle出现在YAML中:---json:|{"page":1,"results":["item","another"],"total_pages":0}但是，当我使用YAML.dump时，它不使用文字样式。我得到这样的东西:---json:!"{\n\"page\":1,\n\"results\":[\n\"item\",\"another\"\n],\n\"total_pages\":0\n}\n"我如何告诉Psych以想要的样式转储标量？解

随机推荐