LUMIERA.clone/tests/core/steam/render-segment-test.cpp

/*
  RenderSegment(Test)  -  Steam-Layer integration test

   Copyright (C)
     2008,            Hermann Vosseler <Ichthyostega@web.de>

  **Lumiera** is free software; you can redistribute it and/or modify it
  under the terms of the GNU General Public License as published by the
  Free Software Foundation; either version 2 of the License, or (at your
  option) any later version. See the file COPYING for further details.

* *****************************************************************/

/** @file render-segment-test.cpp
 ** unit test \ref RenderSegment_test
 */


#include "lib/test/run.hpp"
//#include "lib/util.hpp"

//using std::string;


namespace steam {
namespace test {
  
  
  /****************************************************************//**
   * @test create a render process from a given segment of the Session.
   *       Basically this includes cooperation of all parts of the
   *       Lumiera Steam Layer. For a prepared test-Session we invoke the
   *       controller to create a render process. This includes building
   *       the render pipeline. Finally, we analyse all the created
   *       Structures.
   * @note this test doesn't cover the actual rendering.
   * @see  proc_interface::ControllerFacade
   */
  class RenderSegment_test : public Test
    {
      virtual void
      run (Arg)
        {
          UNIMPLEMENTED ("complete render process for a given test segment of the Session");
        }
    };
  
  
  /** Register this test class... */
  LAUNCHER (RenderSegment_test, "function integration");
  
  
}} // namespace steam::test
-												TDBS (test driven brain storming) :-)

											
										
										
											2007-09-03 02:33:47 +02:00
+								/*
-												Global-Layer-Renaming: adapt lots of documentation

											
										
										
											2018-11-15 21:13:52 +01:00
+								  RenderSegment(Test)  -  Steam-Layer integration test
-												GPL header whitespace

											
										
										
											2010-12-17 23:28:49 +01:00
-												Copyright: clarify and simplify the file headers

 * Lumiera source code always was copyrighted by individual contributors
 * there is no entity "Lumiera.org" which holds any copyrights
 * Lumiera source code is provided under the GPL Version 2+

== Explanations ==
Lumiera as a whole is distributed under Copyleft, GNU General Public License Version 2 or above.
For this to become legally effective, the ''File COPYING in the root directory is sufficient.''

The licensing header in each file is not strictly necessary, yet considered good practice;
attaching a licence notice increases the likeliness that this information is retained
in case someone extracts individual code files. However, it is not by the presence of some
text, that legally binding licensing terms become effective; rather the fact matters that a
given piece of code was provably copyrighted and published under a license. Even reformatting
the code, renaming some variables or deleting parts of the code will not alter this legal
situation, but rather creates a derivative work, which is likewise covered by the GPL!

The most relevant information in the file header is the notice regarding the
time of the first individual copyright claim. By virtue of this initial copyright,
the first author is entitled to choose the terms of licensing. All further
modifications are permitted and covered by the License. The specific wording
or format of the copyright header is not legally relevant, as long as the
intention to publish under the GPL remains clear. The extended wording was
based on a recommendation by the FSF. It can be shortened, because the full terms
of the license are provided alongside the distribution, in the file COPYING.

											
										
										
											2024-11-17 23:42:55 +01:00
+								   Copyright (C)
 ,            Hermann Vosseler <Ichthyostega@web.de>
-												GPL header whitespace

											
										
										
											2010-12-17 23:28:49 +01:00
-												Copyright: clarify and simplify the file headers

 * Lumiera source code always was copyrighted by individual contributors
 * there is no entity "Lumiera.org" which holds any copyrights
 * Lumiera source code is provided under the GPL Version 2+

== Explanations ==
Lumiera as a whole is distributed under Copyleft, GNU General Public License Version 2 or above.
For this to become legally effective, the ''File COPYING in the root directory is sufficient.''

The licensing header in each file is not strictly necessary, yet considered good practice;
attaching a licence notice increases the likeliness that this information is retained
in case someone extracts individual code files. However, it is not by the presence of some
text, that legally binding licensing terms become effective; rather the fact matters that a
given piece of code was provably copyrighted and published under a license. Even reformatting
the code, renaming some variables or deleting parts of the code will not alter this legal
situation, but rather creates a derivative work, which is likewise covered by the GPL!

The most relevant information in the file header is the notice regarding the
time of the first individual copyright claim. By virtue of this initial copyright,
the first author is entitled to choose the terms of licensing. All further
modifications are permitted and covered by the License. The specific wording
or format of the copyright header is not legally relevant, as long as the
intention to publish under the GPL remains clear. The extended wording was
based on a recommendation by the FSF. It can be shortened, because the full terms
of the license are provided alongside the distribution, in the file COPYING.

											
										
										
											2024-11-17 23:42:55 +01:00
+								  **Lumiera** is free software; you can redistribute it and/or modify it
 								  under the terms of the GNU General Public License as published by the
 								  Free Software Foundation; either version 2 of the License, or (at your
 								  option) any later version. See the file COPYING for further details.
-												GPL header whitespace

											
										
										
											2010-12-17 23:28:49 +01:00
-												Copyright: clarify and simplify the file headers

 * Lumiera source code always was copyrighted by individual contributors
 * there is no entity "Lumiera.org" which holds any copyrights
 * Lumiera source code is provided under the GPL Version 2+

== Explanations ==
Lumiera as a whole is distributed under Copyleft, GNU General Public License Version 2 or above.
For this to become legally effective, the ''File COPYING in the root directory is sufficient.''

The licensing header in each file is not strictly necessary, yet considered good practice;
attaching a licence notice increases the likeliness that this information is retained
in case someone extracts individual code files. However, it is not by the presence of some
text, that legally binding licensing terms become effective; rather the fact matters that a
given piece of code was provably copyrighted and published under a license. Even reformatting
the code, renaming some variables or deleting parts of the code will not alter this legal
situation, but rather creates a derivative work, which is likewise covered by the GPL!

The most relevant information in the file header is the notice regarding the
time of the first individual copyright claim. By virtue of this initial copyright,
the first author is entitled to choose the terms of licensing. All further
modifications are permitted and covered by the License. The specific wording
or format of the copyright header is not legally relevant, as long as the
intention to publish under the GPL remains clear. The extended wording was
based on a recommendation by the FSF. It can be shortened, because the full terms
of the license are provided alongside the distribution, in the file COPYING.

											
										
										
											2024-11-17 23:42:55 +01:00
+								* *****************************************************************/
-												TDBS (test driven brain storming) :-)

											
										
										
											2007-09-03 02:33:47 +02:00
-												Doxygen Fixes (#1062)

This changeset fixes a huge pile of problems, as indicated in the
error log of the Doxygen run after merging all the recent Doxygen improvements

unfortunately, auto-linking does still not work at various places.
There is no clear indication what might be the problem.
Possibly the rather unstable Sqlite support in this Doxygen version
is the cause. Anyway, needs to be investigated further.

											
										
										
											2017-04-02 04:22:51 +02:00
+								/** @file render-segment-test.cpp
-												Doxygen: magically insert a reference to the test class

this bit of Sed magic relies on the fact that we happen to write
the almost correct class name of a test into the header comment.

HOWTO:
for F in $(find tests -type f \( -name '*.cpp' \)  -exec egrep -q '§§TODO§§' {} \; -print);
  do sed -r -i -e'
    2          {h;x;s/\s+(.+)\(Test\).*$/\\ref \1_test/;x};
    /§§TODO§§/ {s/§§TODO§§//;G;s/\n//}'
    $F;
done

											
										
										
											2017-02-22 03:17:18 +01:00
+								 ** unit test \ref RenderSegment_test
-												Doxygen: identify all files lacking a @file comment

reason is, only files with a @file comment will be processed
with further documentation commands. For this reason, our Doxygen
documentation is lacking a lot of entries.

HOWTO:
find src -type f \( -name '*.cpp' -or -name '*.hpp' \) -not -exec egrep -q '\*.+@file' {} \; -print -exec sed -i -r -e'\_\*/_,$ { 1,+0 a\
\
\
/** @file §§§\
 ** TODO §§§\
 */
}' {} \;

											
										
										
											2016-11-03 18:20:10 +01:00
+								 */
-												TDBS (test driven brain storming) :-)

											
										
										
											2007-09-03 02:33:47 +02:00
-												finish common->lib transition for the tests
											
										
										
											2008-12-18 04:47:41 +01:00
+								#include "lib/test/run.hpp"
 								//#include "lib/util.hpp"
-												TDBS (test driven brain storming) :-)

											
										
										
											2007-09-03 02:33:47 +02:00
-												mass clean-up: adapt usage of std::cout pretty much everywhere

- remove unnecessary includes
- expunge all remaining usages of boost::format
- able to leave out the expliti string(elm) in output
- drop various operator<<, since we're now picking up
  custom string conversions automatically
- delete diagnostics headers, which are now largely superfluous
- use newer helper functions occasionally

I didn't blindly change any usage of <iostream> though;
sometimes, just using the output streams right away
seems adequate.

											
										
										
											2016-01-07 03:58:29 +01:00
+								//using std::string;
-												TDBS (test driven brain storming) :-)

											
										
										
											2007-09-03 02:33:47 +02:00
-												Global-Layer-Renaming: rename namespaces

											
										
										
											2018-11-15 23:55:13 +01:00
+								namespace steam {
-												cleanup: rectify Proc-Layer namespaces (II)

											
										
										
											2011-12-02 17:50:44 +01:00
+								namespace test {
-												fix **** in doxygen comments

to make them stand out more prominently, some entity comments
where started with a line of starts. Unfortunately, doxygen
(and javadoc) only recogise comments which are started exactly
with /**

This caused quite some comments to be ignored by doxygen.
Credits to Hendrik Boom for spotting this problem!

A workaround is to end the line of stars with *//**

											
										
										
											2013-10-24 23:06:36 +02:00
+								  /****************************************************************//**
-												cleanup: rectify Proc-Layer namespaces (II)

											
										
										
											2011-12-02 17:50:44 +01:00
+								   * @test create a render process from a given segment of the Session.
 								   *       Basically this includes cooperation of all parts of the
-												Global-Layer-Renaming: adapt lots of documentation

											
										
										
											2018-11-15 21:13:52 +01:00
+								   *       Lumiera Steam Layer. For a prepared test-Session we invoke the
-												cleanup: rectify Proc-Layer namespaces (II)

											
										
										
											2011-12-02 17:50:44 +01:00
+								   *       controller to create a render process. This includes building
-												clean-up: trifles

											
										
										
											2025-06-07 23:59:57 +02:00
+								   *       the render pipeline. Finally, we analyse all the created
 								   *       Structures.
-												cleanup: rectify Proc-Layer namespaces (II)

											
										
										
											2011-12-02 17:50:44 +01:00
+								   * @note this test doesn't cover the actual rendering.
 								   * @see  proc_interface::ControllerFacade
 								   */
 								  class RenderSegment_test : public Test
-												TDBS (test driven brain storming) :-)

											
										
										
											2007-09-03 02:33:47 +02:00
+								    {
-												Library: Testsuite maintenance

- SchedulerStress_test simply takes too long to complete (~4 min)
  and is thus aborted by the testrunner. Add a switch to allow for
  a quick smoke test.

- SchedulerCommutator_test aborts due to an unresolved design problem,
  which I marked as failure

- add some convenience methods for passing arguments to tests

											
										
										
											2024-11-15 19:02:48 +01:00
+								      virtual void
 								      run (Arg)
-												TDBS (test driven brain storming) :-)

											
										
										
											2007-09-03 02:33:47 +02:00
+								        {
-												cleanup: rectify Proc-Layer namespaces (II)

											
										
										
											2011-12-02 17:50:44 +01:00
+								          UNIMPLEMENTED ("complete render process for a given test segment of the Session");
-												clean-up: trifles

											
										
										
											2025-06-07 23:59:57 +02:00
+								        }
-												cleanup: rectify Proc-Layer namespaces (II)

											
										
										
											2011-12-02 17:50:44 +01:00
+								    };
 								  /** Register this test class... */
-												Dispatcher-Pipeline: prepare test for the new NodeGraphAttachment

It turns out that the real (not mocked) implementation of JobTicket creation
is already required now for this planned (mock)Dispatcher setup;
moreover, this real implementation turns out to be almost identical
to the mock implementation written recently -- just nested structure
of prerequiste JobTickets need to be changed into a similar structur
of ExitNodes

-- as an aside: rearrange various tests to be more in-line
   with the envisioned architecture of playback and engine

											
										
										
											2023-06-07 04:03:00 +02:00
+								  LAUNCHER (RenderSegment_test, "function integration");
-												cleanup: rectify Proc-Layer namespaces (II)

											
										
										
											2011-12-02 17:50:44 +01:00
-												Dispatcher-Pipeline: prepare test for the new NodeGraphAttachment

It turns out that the real (not mocked) implementation of JobTicket creation
is already required now for this planned (mock)Dispatcher setup;
moreover, this real implementation turns out to be almost identical
to the mock implementation written recently -- just nested structure
of prerequiste JobTickets need to be changed into a similar structur
of ExitNodes

-- as an aside: rearrange various tests to be more in-line
   with the envisioned architecture of playback and engine

											
										
										
											2023-06-07 04:03:00 +02:00
+								}} // namespace steam::test