Add utility function to get windows packaging directory to avoid memory leaks
[ardour.git] / libs / ardour / test / test_util.cc
index f1237f72dfdddec0367040172375e798aafccf5e..f717290ce9c65aa1bf27bf51e1993bed5d23dfe9 100644 (file)
+/*
+    Copyright (C) 2011 Paul Davis
+    Copyright (C) 2011 Tim Mayberry
+
+    This program 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.
+
+    This program is distributed in the hope that it will be useful, but WITHOUT
+    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+    for more details.
+
+    You should have received a copy of the GNU General Public License along
+    with this program; if not, write to the Free Software Foundation, Inc.,
+    675 Mass Ave, Cambridge, MA 02139, USA.
+*/
 #include <fstream>
 #include <sstream>
+
+#include <glibmm/fileutils.h>
+#include <glibmm/miscutils.h>
+
 #include "pbd/xml++.h"
+#include "pbd/file_utils.h"
+
+#include "ardour/session.h"
+#include "ardour/audioengine.h"
+#include "ardour/filesystem_paths.h"
+
+#include "test_util.h"
+
 #include <cppunit/extensions/HelperMacros.h>
 
 using namespace std;
+using namespace ARDOUR;
+using namespace PBD;
+
+static void
+check_nodes (XMLNode const * p, XMLNode const * q, list<string> const & ignore_properties)
+{
+       CPPUNIT_ASSERT_EQUAL (q->is_content(), p->is_content());
+       if (!p->is_content()) {
+               CPPUNIT_ASSERT_EQUAL (q->name(), p->name());
+       } else {
+               CPPUNIT_ASSERT_EQUAL (q->content(), p->content());
+       }
+
+       XMLPropertyList const & pp = p->properties ();
+       XMLPropertyList const & qp = q->properties ();
+       CPPUNIT_ASSERT_EQUAL (qp.size(), pp.size());
+
+       XMLPropertyList::const_iterator i = pp.begin ();
+       XMLPropertyList::const_iterator j = qp.begin ();
+       while (i != pp.end ()) {
+               CPPUNIT_ASSERT_EQUAL ((*j)->name(), (*i)->name());
+               if (find (ignore_properties.begin(), ignore_properties.end(), (*i)->name ()) == ignore_properties.end ()) {
+                       CPPUNIT_ASSERT_EQUAL_MESSAGE ((*j)->name(), (*i)->value(), (*i)->value());
+               }
+               ++i;
+               ++j;
+       }
+
+       XMLNodeList const & pc = p->children ();
+       XMLNodeList const & qc = q->children ();
+
+       CPPUNIT_ASSERT_EQUAL (qc.size(), pc.size());
+       XMLNodeList::const_iterator k = pc.begin ();
+       XMLNodeList::const_iterator l = qc.begin ();
+       
+       while (k != pc.end ()) {
+               check_nodes (*k, *l, ignore_properties);
+               ++k;
+               ++l;
+       }
+}
 
 void
-check_xml (XMLNode* node, string ref_file)
+check_xml (XMLNode* node, string ref_file, list<string> const & ignore_properties)
 {
-       system ("rm -f libs/ardour/test/test.xml");
-       ofstream f ("libs/ardour/test/test.xml");
-       node->dump (f);
-       f.close ();
+       XMLTree ref (ref_file);
+
+       XMLNode* p = node;
+       XMLNode* q = ref.root ();
 
-       stringstream cmd;
-       cmd << "diff -u libs/ardour/test/test.xml " << ref_file;
-       CPPUNIT_ASSERT_EQUAL (0, system (cmd.str().c_str ()));
+       check_nodes (p, q, ignore_properties);
+}
+
+bool
+write_ref (XMLNode* node, string ref_file)
+{
+       XMLTree ref;
+       ref.set_root (node);
+       bool rv = ref.write (ref_file);
+       ref.set_root (0);
+       return rv;
+}
+
+void
+create_and_start_dummy_backend ()
+{
+       AudioEngine* engine = AudioEngine::create ();
+
+       CPPUNIT_ASSERT (AudioEngine::instance ());
+       CPPUNIT_ASSERT (engine);
+       CPPUNIT_ASSERT (engine->set_backend ("None (Dummy)", "", ""));
+
+       init_post_engine ();
+
+       CPPUNIT_ASSERT (engine->start () == 0);
+}
+
+void
+stop_and_destroy_backend ()
+{
+       AudioEngine::instance()->remove_session ();
+       AudioEngine::instance()->stop ();
+       AudioEngine::destroy ();
+}
+
+/** @param dir Session directory.
+ *  @param state Session state file, without .ardour suffix.
+ */
+Session *
+load_session (string dir, string state)
+{
+       Session* session = new Session (*AudioEngine::instance(), dir, state);
+       AudioEngine::instance ()->set_session (session);
+       return session;
+}
+
+PBD::Searchpath
+test_search_path ()
+{
+#ifdef PLATFORM_WINDOWS
+       std::string wsp(windows_package_directory_path());
+       return Glib::build_filename (wsp, "ardour_testdata");
+#else
+       return Glib::getenv("ARDOUR_TEST_PATH");
+#endif
+}
+
+std::string
+new_test_output_dir (std::string prefix)
+{
+       return PBD::tmp_writable_directory (PACKAGE, prefix);
+}
+
+int
+get_test_sample_rate ()
+{
+       return 44100;
 }
-