如何打破依赖以启用单元测试答案

【问题标题】：How to break dependency to enable unittesting如何打破依赖以启用单元测试
【发布时间】：2011-12-29 15:35:15
【问题描述】：

我花了很多时间思考单元测试。我至少购买了Working Effectively with Legacy Code 作为电子书。其中大部分是有道理的，这似乎是一本关于对旧代码进行单元测试的好书。但我仍然认为我需要一个起点，因为我们的项目 Attracs 很大。另请参阅我的通用 question 关于单元测试。

该应用程序有一个 UML 模型来定义类、属性和关系，并使用 Bold for Delphi。在模型中的每次更改之后，我们都会进行一次往返。这会自动为文件 businessclasses.pas 和 BusinessClasses_Interface.inc 中的方法生成声明。如果更改需要更改数据库，也会生成一个 SQL 脚本。这多年来一直运作良好，但我们从未使用过任何单元测试。

所以我添加了一个新的testproject，然后依赖关系引起了麻烦。我得到了

[DCC 错误] Attracs_Interface_Uses.inc(10)：F1026 找不到文件：'MsxSupport.dcu'

所以总结一下错误

AttracsTest.dpr 使用
BusinessClasses.pas 使用
BusinessClasses_Interface.inc 使用
Attracs_Interface_Uses.inc

那么我该如何打破依赖链呢？

请注意，实际上文件要大得多。模型中有超过 300 个类，businessClasses.pas 有超过 53000 行代码...... 作为一个测试用例，我只有一个带有 AddResponsibility 方法的 TPerson 类。但你应该明白其中的原理。

这是我的文件：

AttracsTest.dpr

program AttracsTests;
{$IFDEF CONSOLE_TESTRUNNER}
{$APPTYPE CONSOLE}
{$ENDIF}
uses
  Forms,
  TestFramework,
  GUITestRunner,
  TextTestRunner,
  BusinessClasses in '..\..\server\code\BusinessClasses.pas',
  TestBusinessClasses in 'TestBusinessClasses.pas',
  ArrayOfObject in '..\..\server\code\ArrayOfObject.pas';

{$R *.RES}

begin
  Application.Initialize;
  if IsConsole then
    TextTestRunner.RunRegisteredTests
  else
    GUITestRunner.RunRegisteredTests;
end.

TestBusinessClasses.pas

unit TestBusinessClasses;

interface

uses
  TestFramework,
  ArrayOfObject,
  AttracsAttributes,
  AttracsDefs,
  atXMLObjModel,
  BoldAttributes
  BoldDBInterfaces,
  BoldDefs,
  BoldDeriver,
  BoldDomainElement,
  BoldElements,
  BoldSubscription,
  BoldSystem,
  BoldSystemRT,
  BusinessClasses,   // Trigger the dependency, but also contain info about the classes get and set methods for attributes.  
  Classes,
  Contnrs,
  SysUtils,
  XMLIntf,
  XMLObjModel,
  XMLParser;

type
  TestTPerson = class(TTestCase)
  strict private
    FPerson: TPerson;
  public
    procedure SetUp; override;
    procedure TearDown; override;
  published
    procedure TestAddResponsibility;
  end;

implementation

procedure TestTPerson.SetUp;
begin
  FPerson := TPerson.Create;
end;

procedure TestTPerson.TearDown;
begin
  FPerson.Free;
  FPerson := nil;
end;

procedure TestTPerson.TestAddResponsibility;
var
  ReturnValue: Boolean;
  aSession: TLogonSession;
  aDevType: TDevTypeDef;
  aMarketArea: TMarketArea;
begin
  // TODO: Setup method call parameters
  ReturnValue := FPerson.AddResponsibility(aMarketArea, aDevType, aSession);
  // TODO: Validate method results
end;

initialization
  // Register any test cases with the test runner
  RegisterTest(TestTPerson.Suite);
end.

Attracs_Interface_Uses

AttracsDefs,
atXMLObjModel,
XMLObjModel,
XMLParser,
Contnrs,
XMLIntf,
ArrayOfObject,
BoldDBInterfaces,
MsxSupport         // Line that compiler complain about

BusinessClasses_Interface.inc

(*****************************************)
(*      This file is autogenerated       *)
(*   Any manual changes will be LOST!    *)
(*****************************************)

{$IFNDEF BusinessClasses_Interface.inc}
{$DEFINE BusinessClasses_Interface.inc}

{$IFNDEF BusinessClasses_unitheader}
unit BusinessClasses;
{$ENDIF}

{$INCLUDE Attracs.inc} //PATCH

interface

uses
  // interface uses
  {$INCLUDE Attracs_Interface_Uses.inc} ,
  // interface dependencies
  // attribute classes
  AttracsAttributes,
  BoldAttributes,
  // other
  Classes,
  SysUtils,
  BoldDefs,
  BoldSubscription,
  BoldDeriver,
  BoldElements,
  BoldDomainElement,
  BoldSystemRT,
  BoldSystem;

type
  { forward declarations of all classes }
  TPerson = class;

  TPerson = class(TAmStateObject)
  public
    function AddResponsibility(aMarketArea: TMarketArea; aDevType: TDevTypeDef; aSession: TLogonSession): Boolean; 
  end;

function GeneratedCodeCRC: String;

implementation

uses
  // implementation uses
  {$INCLUDE Attracs_Implementation_Uses.inc} ,
  // implementation dependencies
  // other
  BoldGeneratedCodeDictionary;

{$ENDIF}

Businessclasses.pas

    (*****************************************)
    (*      This file is autogenerated       *)
    (*   Any manual changes will be LOST!    *)
    (*****************************************)

    unit BusinessClasses;

    {$DEFINE BusinessClasses_unitheader}
    {$INCLUDE BusinessClasses_Interface.inc}

    { Includefile for methodimplementations 
      Have concrete implementation of methods}
    {$INCLUDE Person.inc}

    // Some get and set methods fopr attributes in the class

    // attribute FirstName
    function TPerson._Get_M_FirstName: TBAString;
    begin
      assert(ValidateMember('TPerson', 'FirstName', 14, TBAString));
      Result := TBAString(BoldMembers[14]);
    end;

    function TPerson._GetFirstName: String;
    begin
      Result := M_FirstName.AsString;
    end;

    procedure TPerson._SetFirstName(const NewValue: String);
    begin
      M_FirstName.AsString := NewValue;
    end;

    procedure InstallBusinessClasses(BoldObjectClasses: TBoldGeneratedClassList);
    begin
      BoldObjectClasses.AddObjectEntry('Person', TPerson);
    end;

    var
      CodeDescriptor: TBoldGeneratedCodeDescriptor;

    initialization
      CodeDescriptor := GeneratedCodes.AddGeneratedCodeDescriptorWithFunc('BusinessClasses', InstallBusinessClasses, InstallObjectListClasses, GeneratedCodeCRC);
    finalization
      GeneratedCodes.Remove(CodeDescriptor);
    end.

person.inc

function TPerson.AddResponsibility(aMarketArea: TMarketArea; aDevType: TDevTypeDef; aSession: TLogonSession): Boolean;
var
  vOCL: String;
  vDevResponse: TDevResponsible;
begin
  vOCL := Format('DevResponsible.allinstances->select((devType.TypeName = ''%s'') and (marketArea.name = ''%s''))->first',
                         [aDevType.TypeName, aMarketArea.name]);
  vDevResponse := GetApplicationKernel.EvaluateExpressionAsDirectElement(vOCL) as TDevResponsible;

  if not Assigned(vDevResponse) then
    vDevResponse := GetApplicationKernel.CreateAMObject('DevResponsible') as TDevResponsible;

  if Assigned(vDevResponse) then
  begin
    vDevResponse.marketArea := aMarketArea;
    vDevResponse.devType := aDevType;
    vDevResponse.responsiblePers := self;
    NotifyModificationHistory(Now, aSession, Format('Responsible for %s marketarea: %s', [aDevType.TypeName, aMarketArea.Name]));
    Result := True;
  end
  else
    Result := False;
end;

【问题讨论】：

MsxSupport 是不是一个在测试中不起作用的可怕依赖项？还是只是编译器找不到问题？如果它在测试中不起作用，那么你的“接口”单元首先不应该依赖它——你可能想要另一层间接。如果编译器找不到它，那么您需要做的就是更新测试项目的搜索路径或包列表。
此时我不会太担心您需要将哪些单元添加到您的测试项目中，将它们全部添加或使用搜索路径。此时，我应该尽量限制对象之间的依赖关系。要测试您的 TPerson，您不必先创建无数其他对象。如果你这样做，请先尝试解决这些依赖项（DI 某人？）。最后，这也将减轻一些单元间的依赖关系，但就像我说的，我不会太担心这些。
推荐阅读：xUnit Test Patterns: Refactoring Test Code by Gerard Meszaros

标签： unit-testing delphi dependencies dunit bold-delphi

【解决方案1】：

我会做的事情：

分支项目，以便所有更改都可以在安全的“沙盒”中完成
运行 cnWizards 使用 Cleaner（或类似工具）来清理单元依赖项
将所有必需的单元添加到测试项目 dpr 以记录它们，但库路径上的第三方库是众所周知的依赖项
根据可用资源制定计划：搜索出乎意料的依赖项（用于更深入的分析）或低效的依赖项（可以毫无风险地删除）。使用仅指定所需第三方库的库路径的限制性构建脚本进行持续集成会有很大帮助（只要开发人员引入新的依赖项，构建就会中断）
不时将“安全”更改合并回主干，并使用最新的主干版本开始新的迭代

【讨论】：