You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@harmony.apache.org by sm...@apache.org on 2006/05/24 07:04:12 UTC
svn commit: r409071 - in /incubator/harmony/standard/site:
docs/subcomponents/classlibrary/index.html
docs/subcomponents/classlibrary/ser_testing.html
xdocs/subcomponents/classlibrary/index.xml
xdocs/subcomponents/classlibrary/ser_testing.xml
Author: smishura
Date: Tue May 23 22:04:10 2006
New Revision: 409071
URL: http://svn.apache.org/viewvc?rev=409071&view=rev
Log:
Adding to 'project convensions' serialization testing + summarizing convensions for resource files
Added:
incubator/harmony/standard/site/docs/subcomponents/classlibrary/ser_testing.html (with props)
incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/ser_testing.xml (with props)
Modified:
incubator/harmony/standard/site/docs/subcomponents/classlibrary/index.html
incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/index.xml
Modified: incubator/harmony/standard/site/docs/subcomponents/classlibrary/index.html
URL: http://svn.apache.org/viewvc/incubator/harmony/standard/site/docs/subcomponents/classlibrary/index.html?rev=409071&r1=409070&r2=409071&view=diff
==============================================================================
--- incubator/harmony/standard/site/docs/subcomponents/classlibrary/index.html (original)
+++ incubator/harmony/standard/site/docs/subcomponents/classlibrary/index.html Tue May 23 22:04:10 2006
@@ -262,6 +262,14 @@
with other Java implementations.
</p>
</li>
+
+ <li><a href="ser_testing.html">Framework for testing serialization</a>
+ <p>
+ <b>Proposed</b> approach for testing serialization compatibility with other
+ certified implementations, Harmony backward compatibility, placement and
+ naming conventions for resource files.
+ </p>
+ </li>
</ul>
</blockquote>
</td></tr>
Added: incubator/harmony/standard/site/docs/subcomponents/classlibrary/ser_testing.html
URL: http://svn.apache.org/viewvc/incubator/harmony/standard/site/docs/subcomponents/classlibrary/ser_testing.html?rev=409071&view=auto
==============================================================================
--- incubator/harmony/standard/site/docs/subcomponents/classlibrary/ser_testing.html (added)
+++ incubator/harmony/standard/site/docs/subcomponents/classlibrary/ser_testing.html Tue May 23 22:04:10 2006
@@ -0,0 +1,336 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+
+<!--
+Copyright 1999-2004 The Apache Software Foundation
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+
+
+<!-- Content Stylesheet for Site -->
+
+
+<!-- start the processing -->
+ <!-- ====================================================================== -->
+ <!-- GENERATED FILE, DO NOT EDIT, EDIT THE XML FILE IN xdocs INSTEAD! -->
+ <!-- Main Page Section -->
+ <!-- ====================================================================== -->
+ <html>
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"/>
+
+ <meta name="author" value="Harmony Documentation Team">
+ <meta name="email" value="harmony-dev@incubator.apache.org">
+
+
+
+
+
+
+
+ <title>Apache Harmony - Framework for testing serialization</title>
+ </head>
+
+ <body bgcolor="#ffffff" text="#000000" link="#525D76">
+ <table border="0" width="100%" cellspacing="0">
+ <!-- TOP IMAGE -->
+ <tr>
+ <td align='LEFT'>
+ <table><tr><td>
+ <td align="left">
+<a href="http://incubator.apache.org/harmony/"><img src="../../images/harmony-logo.png" alt="Apache Harmony" border="0"/></a>
+</td>
+</td>
+ </td></tr></table>
+ </td>
+ <td align='RIGHT'>
+ <a href="http://incubator.apache.org/harmony/">
+ <img src="http://incubator.apache.org/harmony/images/apache-incubator-logo.png"
+ alt="Apache Harmony" border="0"/></a>
+ </td>
+ </tr>
+ </table>
+ <table border="0" width="100%" cellspacing="4">
+ <tr><td colspan="2">
+ <hr noshade="" size="1"/>
+ </td></tr>
+
+ <tr>
+ <!-- LEFT SIDE NAVIGATION -->
+ <td width="20%" valign="top" nowrap="true">
+
+ <!-- special ACon Logo - leave here for next time
+ <a href="http://apachecon.com/2005/US/">
+ <img src="http://apache.org/images/ac2005us_blue_125x125.jpg" height="125"
+ width="125" border="0" alt="ApacheCon US 2005" />
+ </a>
+ -->
+
+ <!-- regular menu -->
+
+
+ <!-- ============================================================ -->
+
+ <p><strong>General</strong></p>
+ <ul>
+ <li> <a href="../../index.html">Home</a>
+</li>
+
+ <table>
+ </table>
+ <li> <a href="../../license.html">License</a>
+</li>
+
+ <table>
+ </table>
+ <li> <a href="../../contribution_policy.html">Contribution Policy</a>
+</li>
+
+ <table>
+ </table>
+ <li> <a href="../../guidelines.html">Project Guidelines</a>
+</li>
+
+ <table>
+ </table>
+ <li> <a href="http://www.apache.org/">ASF</a>
+</li>
+
+ <table>
+ </table>
+ <li> <a href="../../downloads.html">Downloads</a>
+</li>
+
+ <table>
+ </table>
+ </ul>
+ <p><strong>Community</strong></p>
+ <ul>
+ <li> <a href="../../get-involved.html">Get Involved</a>
+</li>
+
+ <table>
+ </table>
+ <li> <a href="../../contributors.html">Committers</a>
+</li>
+
+ <table>
+ </table>
+ <li> <a href="../../mailing.html">Mailing Lists</a>
+</li>
+
+ <table>
+ </table>
+ <li> <a href="../../documentation/documentation.html">Documentation</a>
+</li>
+
+ <table>
+ </table>
+ <li> <a href="../../faq.html">FAQ</a>
+</li>
+
+ <table>
+ </table>
+ <li> <a href="http://wiki.apache.org/harmony">Wiki</a>
+</li>
+
+ <table>
+ </table>
+ </ul>
+ <p><strong>Development</strong></p>
+ <ul>
+ <li> <a href="../../status.html">How Are We Doing?</a>
+</li>
+
+ <table>
+ </table>
+ <li> <a href="../../roadmap.html">Road Map / TODO</a>
+</li>
+
+ <table>
+ </table>
+ <li> <a href="../../svn.html">Source Code</a>
+</li>
+
+ <table>
+ </table>
+ <li> <a href="http://issues.apache.org/jira/browse/HARMONY">JIRA</a>
+</li>
+
+ <table>
+ </table>
+ <li> <a href="../../related.html">Other Projects</a>
+</li>
+
+ <table>
+ </table>
+ </ul>
+ <p><strong>Subcomponents</strong></p>
+ <ul>
+ <li> <a href="../../subcomponents/classlibrary/index.html">Class Library</a>
+</li>
+
+ <table>
+ <tr><td>
+ <a href="../../subcomponents/classlibrary/status.html">Status</a>
+ </td></tr>
+ </table>
+ <li> <a href="../../subcomponents/jchevm/index.html">Virtual Machine JCHEVM</a>
+</li>
+
+ <table>
+ </table>
+ </ul>
+ </td>
+ <td width="80%" align="left" valign="top">
+ <table border="0" cellspacing="0" cellpadding="2" width="100%">
+ <tr><td bgcolor="#525D76">
+ <font color="#ffffff" face="arial,helvetica,sanserif">
+ <a name="Framework for testing serialization"><strong>Framework for testing serialization</strong></a>
+ </font>
+ </td></tr>
+ <tr><td>
+ <blockquote>
+ <p>
+ <big><em>The framework for testing serialization is currently PROPOSED and being
+ discussed on the development mailing list <code>harmony-dev@incubator.apache.org</code>.
+ Please direct comments and questions there.</em></big>
+ </p>
+ <p>
+ The framework for testing serialization is intended to simplify and formalize
+ development of serialization tests. This document contains guidelines for
+ creating tests and conventions for resource files.
+ </p>
+ <table border="0" cellspacing="0" cellpadding="2" width="100%">
+ <tr><td bgcolor="#828DA6">
+ <font color="#ffffff" face="arial,helvetica,sanserif">
+ <a name="Guidelines for developing serialization tests"><strong>Guidelines for developing serialization tests</strong></a>
+ </font>
+ </td></tr>
+ <tr><td>
+ <blockquote>
+ <p>
+ <big><em>TBD</em></big>
+ </p>
+ </blockquote>
+ </td></tr>
+ <tr><td><br/></td></tr>
+ </table>
+ <table border="0" cellspacing="0" cellpadding="2" width="100%">
+ <tr><td bgcolor="#828DA6">
+ <font color="#ffffff" face="arial,helvetica,sanserif">
+ <a name="Placement and naming conventions for resource files"><strong>Placement and naming conventions for resource files</strong></a>
+ </font>
+ </td></tr>
+ <tr><td>
+ <blockquote>
+ <p>
+ The resource files should follow the next conventions:
+
+ <ul>
+ <li>Root folder for resource files is <code><module root>/src/test/resources/serialization</code>
+ </li>
+
+ <li>Relative path to a resource file <em>MUST</em> match a test's package name.
+ </li>
+
+ <li>A resource file <em>MUST</em> start with a test's name.
+ </li>
+
+ <li>A resource file <em>MUST</em> contain keywords pointing out to testing scenario.
+ <ol>
+
+ <li><code><golden></code> keyword is used for files generated on RI
+ </li>
+
+ <li><code><harmony></code> keyword is used for files generated on
+ Harmony implementation.
+ </li>
+
+ <li><code><negative></code> keyword is used for files that contain
+ broken serial form.
+ </li>
+
+ </ol>
+ </li>
+
+ <li>A resource file name <em>MUST</em> contain some index.<br />
+ <em>Note:</em> if there is only one file the index is not required
+ </li>
+
+ <li>Extension for resource files is 'ser'.
+ </li>
+
+ </ul>
+
+ For example, for test org.apache.harmony.tests.java.lang.SomeClassTest we have following:
+ <blockquote>
+ <pre>
+modules/luni/src/test/resources/serialization
+ |
+ \---org/apache/harmony/tests/java/lang
+ |
+ \---SomeClassTest.golden.0.ser
+ SomeClassTest.golden.1.ser
+ SomeClassTest.golden.2.ser
+ SomeClassTest.harmony.0.ser
+ SomeClassTest.harmony.1.ser
+ SomeClassTest.negative.ser
+ </pre>
+ </blockquote>
+
+ </p>
+ </blockquote>
+ </td></tr>
+ <tr><td><br/></td></tr>
+ </table>
+ </blockquote>
+ </p>
+ </td></tr>
+ <tr><td><br/></td></tr>
+ </table>
+ </td>
+ </tr>
+
+ <!-- FOOTER -->
+ <tr><td colspan="2">
+ <hr noshade="" size="1"/>
+ </td></tr>
+ <tr><td colspan="2">
+ <div align="center"><font color="#525D76" size="-1"><em>
+ Copyright © 2003-2006, The Apache Software Foundation
+ </em></font></div>
+ </td></tr>
+ </table>
+ </body>
+ </html>
+<!-- end the processing -->
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Propchange: incubator/harmony/standard/site/docs/subcomponents/classlibrary/ser_testing.html
------------------------------------------------------------------------------
svn:eol-style = native
Modified: incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/index.xml
URL: http://svn.apache.org/viewvc/incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/index.xml?rev=409071&r1=409070&r2=409071&view=diff
==============================================================================
--- incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/index.xml (original)
+++ incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/index.xml Tue May 23 22:04:10 2006
@@ -74,6 +74,14 @@
with other Java implementations.
</p>
</li>
+
+ <li><a href="ser_testing.html">Framework for testing serialization</a>
+ <p>
+ <b>Proposed</b> approach for testing serialization compatibility with other
+ certified implementations, Harmony backward compatibility, placement and
+ naming conventions for resource files.
+ </p>
+ </li>
</ul>
</subsection>
Added: incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/ser_testing.xml
URL: http://svn.apache.org/viewvc/incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/ser_testing.xml?rev=409071&view=auto
==============================================================================
--- incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/ser_testing.xml (added)
+++ incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/ser_testing.xml Tue May 23 22:04:10 2006
@@ -0,0 +1,107 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+
+ Copyright 2006 The Apache Software Foundation
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+<document>
+
+ <properties>
+ <title>Framework for testing serialization</title>
+ <author email="harmony-dev@incubator.apache.org">Harmony Documentation Team</author>
+ </properties>
+
+<body>
+
+<section name="Framework for testing serialization">
+ <p>
+ <big><em>The framework for testing serialization is currently PROPOSED and being
+ discussed on the development mailing list <code>harmony-dev@incubator.apache.org</code>.
+ Please direct comments and questions there.</em></big>
+ </p>
+ <p>
+ The framework for testing serialization is intended to simplify and formalize
+ development of serialization tests. This document contains guidelines for
+ creating tests and conventions for resource files.
+ </p>
+
+<subsection name="Guidelines for developing serialization tests">
+ <p>
+ <big><em>TBD</em></big>
+ </p>
+</subsection>
+
+<subsection name="Placement and naming conventions for resource files">
+ <p>
+ The resource files should follow the next conventions:
+
+ <ul>
+ <li>Root folder for resource files is <code><module root>/src/test/resources/serialization</code>
+ </li>
+
+ <li>Relative path to a resource file <em>MUST</em> match a test's package name.
+ </li>
+
+ <li>A resource file <em>MUST</em> start with a test's name.
+ </li>
+
+ <li>A resource file <em>MUST</em> contain keywords pointing out to testing scenario.
+ <ol>
+
+ <li><code><golden></code> keyword is used for files generated on RI
+ </li>
+
+ <li><code><harmony></code> keyword is used for files generated on
+ Harmony implementation.
+ </li>
+
+ <li><code><negative></code> keyword is used for files that contain
+ broken serial form.
+ </li>
+
+ </ol>
+ </li>
+
+ <li>A resource file name <em>MUST</em> contain some index.<br/>
+ <em>Note:</em> if there is only one file the index is not required
+ </li>
+
+ <li>Extension for resource files is 'ser'.
+ </li>
+
+ </ul>
+
+ For example, for test org.apache.harmony.tests.java.lang.SomeClassTest we have following:
+ <blockquote>
+ <pre>
+modules/luni/src/test/resources/serialization
+ |
+ \---org/apache/harmony/tests/java/lang
+ |
+ \---SomeClassTest.golden.0.ser
+ SomeClassTest.golden.1.ser
+ SomeClassTest.golden.2.ser
+ SomeClassTest.harmony.0.ser
+ SomeClassTest.harmony.1.ser
+ SomeClassTest.negative.ser
+ </pre>
+ </blockquote>
+
+ </p>
+</subsection>
+</section>
+</body>
+</document>
Propchange: incubator/harmony/standard/site/xdocs/subcomponents/classlibrary/ser_testing.xml
------------------------------------------------------------------------------
svn:eol-style = native