From d06afca696d1e948e39628e8ce5e7006567db82f Mon Sep 17 00:00:00 2001 From: kelvingoodson Date: Fri, 21 May 2010 13:34:36 +0000 Subject: TUSCANY-3563 beginning to establish the pattern for the new style samples' READMEs git-svn-id: http://svn.us.apache.org/repos/asf/tuscany@947001 13f79535-47bb-0310-9956-ffa450edef68 --- sca-java-2.x/trunk/samples/README | 17 +++-- .../contribution-binding-ws-calculator/README | 88 ++-------------------- 2 files changed, 19 insertions(+), 86 deletions(-) (limited to 'sca-java-2.x/trunk/samples') diff --git a/sca-java-2.x/trunk/samples/README b/sca-java-2.x/trunk/samples/README index b0a281f566..e6b7f25a98 100644 --- a/sca-java-2.x/trunk/samples/README +++ b/sca-java-2.x/trunk/samples/README @@ -27,8 +27,17 @@ migrated to this new structure. Please visit the 2.x documentation in our website [1] to get a better understanding of SCA and Tuscany 2.x -[1] http://tuscany.apache.org/documentation-2x/ +Running the New Style samples +----------------------------- + +To run a new style sample there are 3 basic steps +1) build the contribution: using either mvn, ant or your IDE +2) unit test the contribution: if you used mvn or ant in step 1 then you will already have done this; + if you used an IDE follow your usual steps to run the unit test in the contribution's module +3) launch the contribution: go to one of the launcher* subdirectoris of the samples root directory= command line (JSE or OSGi), embedded (JSE or OSGi), SCAClient or Eclipse launcher + +[1] http://tuscany.apache.org/documentation-2x/ SCA Samples @@ -64,11 +73,7 @@ Launchers launcher-eclipse - I what's this? Just embedded-jse with eclipse project files provided? Do we need this? -Using the sample contributions ------------------------------- -contribution build = mvn or ant or IDE in the contribution module -contribution unit test = mvn or ant or IDE in the contribution module -contribution launch = command line (JSE or OSGi), embedded (JSE or OSGi), SCAClient or Eclipse launcher + 1/ Use local SCAClient diff --git a/sca-java-2.x/trunk/samples/contribution-binding-ws-calculator/README b/sca-java-2.x/trunk/samples/contribution-binding-ws-calculator/README index fb5afcc7ec..14636d090e 100644 --- a/sca-java-2.x/trunk/samples/contribution-binding-ws-calculator/README +++ b/sca-java-2.x/trunk/samples/contribution-binding-ws-calculator/README @@ -1,72 +1,20 @@ -Calculator Sample -================= -This sample implements a simple calculator using SCA components. +Calculator Contribution Sample +============================== -The README in the samples directory (the directory above this) provides -general instructions about building and running samples. Take a look there -first. +This directory contains code which implements a simple calculator SCA contribution. -If you just want to run it to see what happens open a command prompt, navigate -to this sample directory and do: - -ant run - -OR if you don't have ant, on Windows do - -java -cp ..\..\features\tuscany-sca-manifest.jar;target\sample-binding-ws-calculator.jar sample.SampleClientImpl - -and on *nix do - -java -cp ../../features/tuscany-sca-manifest.jar:target/sample-binding-ws-calculator.jar sample.SampleClientImpl +The contribution can be run as a tuscany application using one of the tuscany launchers +as described in the README in the root directory of the samples. Sample Overview --------------- The sample provides a single calculator service with a default SCA (java) -binding. The CalculatorClient exercises this interface by calling add, +binding. The launcher exercises this interface by calling add, subtract, multiply and divide operations. This results in messages passing to the appropriate components in the composite across the local wires. -calculator/ - src/ - main/ - java/ - calculator/ - CalculatorService.java - the first component, calls +-/* as - appropriate - CalculatorServiceImpl.java - AddService.java - adds two numbers - AddServiceImpl.java - SubtractService.java - subtracts one number from another - SubtractServiceImpl.java - MultiplyService.java - multiplies two numbers - MultiplyServiceImpl.java - DivideService.java - divides one number by another - DivideServiceImpl.java - CalculatorClient.java - starts the SCA Runtime and - deploys the Calculator.composite. - It then calls the deployed Calculator - Components services - resources/ - Calculator.composite - the SCA assembly for this sample - test/ - java/ - calculator/ - CalculatorTestCase.java - JUnit test case - calculator.png - a pictorial representation of the sample - .composite file - build.xml - the Ant build file - pom.xml - the Maven build file - -Building And Running The Sample Using Ant ------------------------------------------ -With the binary distribution the sample can be built and run using Ant as -follows - -cd calculator -ant compile -ant run - -You should see the following output from the run target. +You should see the following output (depending on the launcher you use, this output +may be surrounded by other output). run: [java] 3 + 2=5.0 @@ -74,24 +22,4 @@ run: [java] 3 * 2=6.0 [java] 3 / 2=1.5 -Building And Running The Sample Using Maven -------------------------------------------- -With either the binary or source distributions the sample can be built and run -using Maven as follows. - -cd calculator -mvn - -You should see the following output from the test phase. - -------------------------------------------------------- - T E S T S -------------------------------------------------------- -Running calculator.CalculatorTestCase -Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 1.272 sec - -Results : - -Tests run: 1, Failures: 0, Errors: 0, Skipped: 0 -This shows that the Junit test cases have run successfully. -- cgit v1.2.3