利用 Ruby 简化你的 Java 测试

阅读数:1499 2008 年 8 月 26 日

话题:JavaRuby测试语言 & 开发

本文是 Productive Java with Ruby 系列文章的第一篇,我将从单元测试这个话题开始,让 Java 的开发人员能够在实际工作中利用 Ruby 提高工作效率。

Martin Fowler:当然(愿意花掉一半的时间来写单元测试)!因为单元测试能够使你更快地完成工作。无数次的实践已经证明这一点。你的时间越是紧张,就越是要写单元测试,它看上去慢,但实际上能够帮助你更快、更舒服地达到目标。

单元测试很重要,但是……

单元测试的重要性,我想再多做一些强调也不为过。但实际情况是我经常听到 Java 开发人员抱怨单元测试繁琐、难写。虽然勉强为之,却疲于奔命,并没有体会到它的好处!最终造成的结果是出现了大量只能运行一次的单元测试。是将责任简单归结于开发人员?还是开发流程或制度的不完善?

平心而论,我自己在做 TDD 或单元测试的时候,有很多时候也确实觉得无趣,尤其是在一些准备测试数据或测试环境的工作上,例如我们经常需要随机生成特定长度的字符串用于测试,需要如下代码:

复制代码
public String getRandomAlphabetic(int count) {

count = count <= 0 ? 5 : count; // 默认为 5

// 构建一个包含所有英文字母的字符串

String alphabet="abcdefghijklmnopqistuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ";

StringBuffer sb = new StringBuffer(count);

for (int i = 0; i < count; i++) {

int character=(int)(Math.random()*26);

sb.append(alphabet.substring(character, character+1));

}

return sb.toString();

}

如果用 Ruby 的话

复制代码
def random_alphabetic(size=5)

chars = ('a'..'z').to_a + ('A'..'Z').to_a # 构建一个从 a 到 Z 的一个字母表数组

(0...size).collect { chars[rand(chars.length)] }.join # 从 chars 数组中返回指定长度的随机字符数组(默认 5 个),调用 join 方法,将这个数组中的所有元素连接成一个字符串

end

对比后大家感觉如何?有经验的开发人员马上会挑战说,我们有现成的 commons-lang 库,简单调用 RandomStringUtils.randomAlphabetic(5) 就可以完成任务,可我想问的是,如果没有第三方库的支持,你更愿意用哪种方式?还可以想象构建一个树状结构的数据,Ruby 的方式

复制代码


data =<<-EOF

{

"order_id": "xxx-xxxxx-xxx",

"books": [

{"ISBN": "2323-2323", "number": 2, "price": 20.00},

{"ISBN": "2323-2324", "number": 3, "price": 30.00},

{"ISBN": "2323-2325", "number": 2, "price": 20.00},

{"ISBN": "2323-2326", "number": 3, "price": 30.00},

{"ISBN": "2323-2327", "number": 2, "price": 20.00}

]

}

EOF # 该数据为 json 格式的一段字符串

order = JSON.parse(data)



p order['books'][0]['ISBN'] #=> 2323-2323

用 Java 该怎样完成,很多人会祭出 Java 世界中最被滥用的七种武器之首“xml”,即便如此能完成的如此优雅吗?如果不是简单的“语言宗教崇拜”,至少我会毫不犹豫的选择用 Ruby 的方式完成任务。省点时间,早点下班陪陪老婆也好啊!:)

在 Ruby 的世界里

那作为一个 Java 的开发人员,如何享受到 Ruby 在测试方面给我们带来的好处呢?事实上 Java 早就为 Ruby、Python 等脚本语言做好了准备,JRuby 是 sun 对 Ruby on JVM 的官方支持,现在的版本是 1.1.3,已经能够非常好的让 Ruby 运行在 Java 的世界里。

在开始之前,我想简单介绍一下跟本文相关的 Ruby 及 JRuby 的基本用法,具体参考 Ruby Home

复制代码
# 这是一段注释

puts 'Hello, World !' # 打印 Hello, World! 这个字符串,相当于 Java 中的 System.out.println

('a'..'z') # 声明一个 a 到 z 的 range 类型的数据,range 表示一个连续的范围,当然也可以是一段连续的数字

('a'..'z').to_a # 简单调用方法 to_a 将一个 range 类型的数据转换成一个数组

<<-EOF



...

EOF # Ruby 通过配对 EOF 的方式声明一个多行的字符串

[1,2,3,4,5] # 声明一个数组



[..].each {|it| puts it } # 通过 each 方法遍历每个元素,其中{...}表示一个代码块,在这里的语义是在遍历每个元素时打印这个元素,其中 it 是隐式声明的参数,表示当前被遍历到的元素

对于数组可以用 select, find, collect 等方法遍历,用 <<, push, pop, delete 等方法改变数组里的元素

h = {'id'=>'1', 'name'=>'foo', 'age'=>24} # 简单声明一个 Hash



h['name'] = 'bar' # 对 key 为 name 的条目赋值

h['age'] #24

class Foo < Base # 通过 class 关键字声明一个类,‘< Base’表示从基类 Base 继承



@name # 声明一个实例变量

@@count # 声明一个类变量,相当于 Java 中 static 关键字修饰的变量

end

在 JRuby 中可以直接使用所有的 Ruby 类和方法,也能够很轻松的调用 Java 的类库,实际上 JRuby 将 Ruby 代码动态编译成 JVM 的字节码,具体参考 JRuby

复制代码


require 'java' # 引入对 Java 的支持

import 'java.util.ArrayList' # 导入需要的某个包

list = ArrayList.new # 创建一个 ArrayList



[1,2,3,4,5].to_java # 将 Ruby 类型转成对应的 Java 类型

从上面简短的例子和基本介绍,我们能发现什么?Ruby 对数组,字符串等基本类型提供了强大的支持,而这些恰恰是 Java 缺乏的,我们没有办法简单的创建一个数组,不能用简单的方式遍历这些集合,甚至都不能简单声明一个多行的字符串。而这些在进行测试工作,准备测试数据的时候都是必不可少的!利用 Ruby 的这些特性,我们可以极大的增加开发的效率,摆脱相当多繁琐的工作。当然,这些只是 Ruby 为我们提供的诸多好处中最直观的部分,随着我们的讨论深入,我们将看到越来越多有意思的特性。

准备工作

用 Ruby 进行测试,我们需要JtestR这个专门为简化 Java 测试而准备的 Ruby 测试工具,当前的最新版本是 0.3.1。如果你使用maven,在pom.xml中加入

复制代码
<plugins>

        ...

        <plugin>

            <groupId>org.jtestr</groupId>

            <artifactId>jtestr</artifactId>

            <version>0.3.1</version>

            <configuration>

                <!-- Ruby 测试文件所在目录 -->

                <tests>src/test/ruby</tests>

            </configuration>

            <executions>

                <execution>

                    <goals>

                        <goal>test</goal>

                    </goals>

                </execution>

            </executions>

        </plugin>

        ...

    </plugins>



使用 ant 的开发人员请参考这里。用 Ruby 做单元测试和 Java 一样,简单从Test::Unit::TestCase继承即可

复制代码


class MyFirstJRubyTests < Test::Unit::TestCase

def test_true

assert true

end

end

可以将这个测试文件简单拷贝到myProj/src/test/ruby目录下,运行mvn test,你会看到JtestR产生的测试结果输出

复制代码


[INFO] [jtestr:test {execution: default}]

Other TestUnit: 1 tests, 0 failures, 0 errors



在这段输出报告之上,你应该还能看到正常的 Java unit testcase 输出的测试结果,这表明,我们可以在开发的过程中同时选择用 Java 的方式测试,或用 Ruby 的方式测试!

JRuby 测试之旅

好了,一切准备好之后,就可以开始我们的 Ruby 测试之旅了!你一定不希望自己苦心经营的 blog 或论坛上出现某些“不和谐”的词,尤其是在这举国欢庆的特殊阶段。你设计了一个专门用于过滤带有这些关键服务接口

复制代码


public interface KeywordFilterService {

// 过滤访客评论字符串数组,返回一个新的不包含敏感关键字的结果

String[] filter(String[] comments);

// 获取被过滤的访客评论

String[] getFiltedComments();

}

并写了一个很简单的实现类class KeywordFilterServiceImpl implements KeywordFilterService,这个类的实现我们就暂不关心,把重点聚集在如何对这个实现类进行测试上。首先在myProj/src/test/ruby目录下新建test_keyword_filter_service.rb文件,键入以下内容

复制代码


require 'test/unit'

class KeywordFilterServiceTest < Test::Unit::TestCase



def setup

@keywords = %w{X XX XXX XXXX XXXXX XXXXXX XXXXXXX} # 不用加引号,更方便

end

def test_filter

end



end

setup 方法准备了我们要测试的关键字数据,在 Ruby 中 %w{...}用来简单定义字符串数组。test_xxx 方法就是我们的测试方法。有了关键字数据后我们还需要一组用来测试的测试数据,里面一部分包含我们的关键字。我决定用上面定义的随机生成字符串的方式产生这些测试数据

复制代码


def random_alphabetic(size=5)

chars = ('a'..'z').to_a + ('A'..'Z').to_a

(0...size).collect { chars[rand(chars.length)] }.join

end

def random_comments



comments ||= []

10.times do

keyword = rand(10) % 3 == 0 ? ' ' : @keywords[rand(@keywords.length)] # 随机决定是否包含关键字

comment = random_alphabetic + keyword + random_alphabetic

comments << comment

end

return comments

end

这样,每次产生 10 条数据,有近三分之一的数据中包含不和谐的关键字。有了测试数据剩下的工作就很简单了,我们只需调用写好的 Java 服务,对返回的测试数据进行验证即可,由于需要调用 Java 服务,和 Java 一样,我们首先要引入类:

复制代码
import 'com.alisoft.research.JRuby.service.KeywordFilterServiceImpl'

测试方法实现如下:

复制代码


def test_filter

comments = random_comments

service = KeywordFilterServiceImpl.new(@keywords.to_java :String)

filted = service.filter(comments.to_java :String)

forbiddens = service.getFiltedComments

assert forbiddens.length == comments.length - filted.length



assert_equal forbiddens.sort, (comments - filted).sort

end

其中,有两点需要注意,首先,我们可以通过to_java方法将 Ruby 类型转换成 Java 类型,例如上面将@keywords.to_java :String表明将 Ruby 数组转换成 Java 的 String 数组。第二,Ruby 对数组支持“-”的操作,表示将一个数组减去和另一个数组中相同的元素,非常的直观!很明显,被过滤的数组应该等于原来的数组减去过滤后的结果!运行mvn test,我们将看到

复制代码


[INFO] [jtestr:test {execution: default}]

Other TestUnit: 2 tests, 0 failures, 0 errors



结论

说明新增加的测试通过!最后我们来对比一下实现同样的功能 Ruby 和 Java 的差别

复制代码


Ruby:

require 'test/unit'

import 'com.alisoft.research.JRuby.service.KeywordFilterServiceImpl'

class KeywordFilterServiceTest < Test::Unit::TestCase



def setup

@keywords = %w{X XX XXX XXXX XXXXX XXXXXX XXXXXXX}

end

def test_filter



comments = random_comments

service = KeywordFilterServiceImpl.new(@keywords.to_java :String)

filted = service.filter(comments.to_java :String)

forbiddens = service.getFiltedComments

assert forbiddens.length == comments.length - filted.length



assert_equal forbiddens.sort, (comments - filted).sort

end

def random_alphabetic(size=5)



chars = ('a'..'z').to_a + ('A'..'Z').to_a

(0...size).collect { chars[rand(chars.length)] }.join

end

def random_comments



comments ||= []

10.times do

keyword = rand(10) % 3 == 0 ? ' ' : @keywords[rand(@keywords.length)]

comment = random_alphabetic + keyword + random_alphabetic

comments << comment

end

return comments

end

end

Java:



package com.alisoft.research.JRuby.test;

import static org.junit.Assert.assertArrayEquals;



import static org.junit.Assert.assertEquals;

import Java.util.ArrayList;



import Java.util.Arrays;

import Java.util.List;

import org.apache.commons.lang.RandomStringUtils;



import org.apache.commons.lang.math.RandomUtils;

import org.junit.Test;

import com.alisoft.research.JRuby.service.KeywordFilterServiceImpl;

public class KeywordFilterServiceTest {

@Test



public void testFilteredResults() {

String[] comments = getRandomComments();

KeywordFilterServiceImpl service = new KeywordFilterServiceImpl(



getKeywords());

String[] filted = service.filter(comments);



String[] forbiddens = service.getFiltedComments();

assertEquals(filted.length + forbiddens.length, comments.length);

assertArrayEquals(forbiddens, sub(comments, filted));



}

// 实现减法操作

private String[] sub(String[] all, String[] part) {

List allList = new ArrayList(Arrays.asList(all));

allList.removeAll(Arrays.asList(part));

return allList.toArray(new String[allList.size()]);

}

private String[] getRandomComments() {



String[] comments = new String[RandomUtils.nextInt(10)];

for (int i = 0; i < comments.length; i++) {

String comment = RandomStringUtils.randomAlphabetic(5);

String keyword = RandomUtils.nextBoolean() ? getKeywords()[RandomUtils

.nextInt(getKeywords().length)]

: "";

comment += keyword + RandomStringUtils.randomAlphabetic(5);

comments[i] = comment;

}

return comments;

}

private String[] getKeywords() {



String[] keywords = new String[] { "X", "XX", "XXX", "XXXX",

"XXXXX", "XXXXXX", "XXXXXXX" };

return keywords;

}

}

在借助了apache-commons-lang之后,LOC: Java 58, Ruby 35。大家也可以注意一下 Java 中实现两个数组“减法”的代码对比 Ruby 的实现,Ruby 明显更为直观,更有效率!

利用 Ruby 对 Java 进行测试的基础介绍就到这里,希望能抛砖引玉,引起大家的兴趣。下一篇我将和大家再讨论一些例如 mock 等更高级的测试话题。


作者介绍:殷安平,现任阿里软件研究院平台二部架构师,工作 6 年以来一直从事 Java 开发,爱好广泛,长期关注敏捷开发。对动态语言有了强烈的兴趣,致力于将动态语言带入实际工作中!工作之余喜欢摄影和读书。 个人 RSS 聚合: http://friendfeed.com/yapex。联系方式:anping.yin AT alibaba-inc.com

志愿参与 InfoQ 中文站内容建设,请邮件至editors@cn.infoq.com。也欢迎大家到InfoQ 中文站用户讨论组参与我们的线上讨论。