issue 86 allow sync folder to be specified, move Config class and add basic unit test

pull/40/head
justin 2012-07-29 18:17:10 +01:00
parent e0383a843c
commit 034891a610
15 changed files with 210 additions and 72 deletions

View File

@ -17,7 +17,7 @@
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/ */
#include "Config.hh" #include "util/Config.hh"
#include "drive/Drive.hh" #include "drive/Drive.hh"
@ -46,6 +46,9 @@
const std::string client_id = "22314510474.apps.googleusercontent.com" ; const std::string client_id = "22314510474.apps.googleusercontent.com" ;
const std::string client_secret = "bl4ufi89h-9MkFlypcI7R785" ; const std::string client_secret = "bl4ufi89h-9MkFlypcI7R785" ;
const std::string defaultRootFolder = ".";
const std::string defaultConfigFileName = ".grive";
const char *configFileEnvironmentVariable = "GR_CONFIG";
using namespace gr ; using namespace gr ;
@ -66,8 +69,8 @@ int Main( int argc, char **argv )
{ {
InitGCrypt() ; InitGCrypt() ;
Config config ; std::string rootFolder = defaultRootFolder;
std::auto_ptr<log::CompositeLog> comp_log(new log::CompositeLog) ; std::auto_ptr<log::CompositeLog> comp_log(new log::CompositeLog) ;
LogBase* console_log = comp_log->Add( std::auto_ptr<LogBase>( new log::DefaultLog ) ) ; LogBase* console_log = comp_log->Add( std::auto_ptr<LogBase>( new log::DefaultLog ) ) ;
@ -81,6 +84,7 @@ int Main( int argc, char **argv )
( "help,h", "Produce help message" ) ( "help,h", "Produce help message" )
( "version,v", "Display Grive version" ) ( "version,v", "Display Grive version" )
( "auth,a", "Request authorization token" ) ( "auth,a", "Request authorization token" )
( "path,p", po::value<std::string>(), "Path to sync")
( "verbose,V", "Verbose mode. Enable more messages than normal.") ( "verbose,V", "Verbose mode. Enable more messages than normal.")
( "log-xml", "Log more HTTP responses as XML for debugging.") ( "log-xml", "Log more HTTP responses as XML for debugging.")
( "new-rev", "Create new revisions in server for updated files.") ( "new-rev", "Create new revisions in server for updated files.")
@ -101,6 +105,57 @@ int Main( int argc, char **argv )
std::cout << desc << std::endl ; std::cout << desc << std::endl ;
return 0 ; return 0 ;
} }
boost::shared_ptr<Config> config ;
if ( vm.count( "log" ) )
{
std::auto_ptr<LogBase> file_log(new log::DefaultLog( vm["log"].as<std::string>() )) ;
file_log->Enable( log::debug ) ;
file_log->Enable( log::verbose ) ;
file_log->Enable( log::info ) ;
file_log->Enable( log::warning ) ;
file_log->Enable( log::error ) ;
file_log->Enable( log::critical ) ;
// log grive version to log file
file_log->Log( log::Fmt("grive version " VERSION " " __DATE__ " " __TIME__), log::verbose ) ;
file_log->Log( log::Fmt("current time: %1%") % DateTime::Now(), log::verbose ) ;
comp_log->Add( file_log ) ;
}
if ( vm.count( "verbose" ) )
{
console_log->Enable( log::verbose ) ;
}
options.Add( "log-xml", Json(vm.count("log-xml") > 0) ) ;
options.Add( "new-rev", Json(vm.count("new-rev") > 0) ) ;
if ( vm.count( "debug" ) )
{
console_log->Enable( log::verbose ) ;
console_log->Enable( log::debug ) ;
}
// config file will be (in order of preference)
// value specified in environment string
// value specified in defaultConfigFileName in path from commandline --path
// value specified in defaultConfigFileName in current directory
const char *envConfigFileName = ::getenv( configFileEnvironmentVariable ) ;
if (envConfigFileName) {
config.reset(new Config(envConfigFileName));
} else if ( vm.count( "path" ) ) {
rootFolder = vm["path"].as<std::string>();
config.reset(new Config( fs::path(rootFolder) / fs::path(defaultConfigFileName) ));
} else {
config.reset(new Config( defaultConfigFileName) );
}
Log( "config file name %1%", config->ConfigFile().string(), log::verbose );
if ( vm.count( "auth" ) ) if ( vm.count( "auth" ) )
{ {
std::cout std::cout
@ -119,24 +174,8 @@ int Main( int argc, char **argv )
token.Auth( code ) ; token.Auth( code ) ;
// save to config // save to config
config.Get().Add( "refresh_token", Json( token.RefreshToken() ) ) ; config->Get().Add( "refresh_token", Json( token.RefreshToken() ) ) ;
config.Save() ; config->Save() ;
}
if ( vm.count( "log" ) )
{
std::auto_ptr<LogBase> file_log(new log::DefaultLog( vm["log"].as<std::string>() )) ;
file_log->Enable( log::debug ) ;
file_log->Enable( log::verbose ) ;
file_log->Enable( log::info ) ;
file_log->Enable( log::warning ) ;
file_log->Enable( log::error ) ;
file_log->Enable( log::critical ) ;
// log grive version to log file
file_log->Log( log::Fmt("grive version " VERSION " " __DATE__ " " __TIME__), log::verbose ) ;
file_log->Log( log::Fmt("current time: %1%") % DateTime::Now(), log::verbose ) ;
comp_log->Add( file_log ) ;
} }
if ( vm.count( "version" ) ) if ( vm.count( "version" ) )
{ {
@ -144,19 +183,6 @@ int Main( int argc, char **argv )
<< "grive version " << VERSION << ' ' << __DATE__ << ' ' << __TIME__ << std::endl ; << "grive version " << VERSION << ' ' << __DATE__ << ' ' << __TIME__ << std::endl ;
return 0 ; return 0 ;
} }
if ( vm.count( "verbose" ) )
{
console_log->Enable( log::verbose ) ;
}
options.Add( "log-xml", Json(vm.count("log-xml") > 0) ) ;
options.Add( "new-rev", Json(vm.count("new-rev") > 0) ) ;
if ( vm.count( "debug" ) )
{
console_log->Enable( log::verbose ) ;
console_log->Enable( log::debug ) ;
}
if ( vm.count( "force" ) ) if ( vm.count( "force" ) )
{ {
options.Add( "force", Json(true) ) ; options.Add( "force", Json(true) ) ;
@ -167,7 +193,7 @@ int Main( int argc, char **argv )
std::string refresh_token ; std::string refresh_token ;
try try
{ {
refresh_token = config.Get()["refresh_token"].Str() ; refresh_token = config->Get()["refresh_token"].Str() ;
} }
catch ( Exception& e ) catch ( Exception& e )
{ {
@ -181,7 +207,8 @@ int Main( int argc, char **argv )
OAuth2 token( refresh_token, client_id, client_secret ) ; OAuth2 token( refresh_token, client_id, client_secret ) ;
AuthAgent agent( token, std::auto_ptr<http::Agent>( new http::CurlAgent ) ) ; AuthAgent agent( token, std::auto_ptr<http::Agent>( new http::CurlAgent ) ) ;
Drive drive( &agent, options ) ;
Drive drive( &agent, options, rootFolder ) ;
drive.DetectChanges() ; drive.DetectChanges() ;
if ( vm.count( "dry-run" ) == 0 ) if ( vm.count( "dry-run" ) == 0 )
@ -192,7 +219,7 @@ int Main( int argc, char **argv )
else else
drive.DryRun() ; drive.DryRun() ;
config.Save() ; config->Save() ;
Log( "Finished!", log::info ) ; Log( "Finished!", log::info ) ;
return 0 ; return 0 ;
} }

View File

@ -51,9 +51,10 @@ namespace
const std::string state_file = ".grive_state" ; const std::string state_file = ".grive_state" ;
} }
Drive::Drive( http::Agent *http, const Json& options ) : Drive::Drive( http::Agent *http, const Json& options, const std::string &rootFolder) :
m_http ( http ), m_http( http ),
m_state ( state_file, options ), m_state( fs::path(rootFolder), fs::path(rootFolder) / fs::path(state_file), options ),
m_rootFolder(rootFolder),
m_options ( options ) m_options ( options )
{ {
assert( m_http != 0 ) ; assert( m_http != 0 ) ;
@ -127,7 +128,7 @@ void Drive::SyncFolders( )
void Drive::DetectChanges() void Drive::DetectChanges()
{ {
Log( "Reading local directories", log::info ) ; Log( "Reading local directories", log::info ) ;
m_state.FromLocal( "." ) ; m_state.FromLocal( m_rootFolder ) ;
long prev_stamp = m_state.ChangeStamp() ; long prev_stamp = m_state.ChangeStamp() ;
Trace( "previous change stamp is %1%", prev_stamp ) ; Trace( "previous change stamp is %1%", prev_stamp ) ;

View File

@ -40,7 +40,7 @@ class Entry ;
class Drive class Drive
{ {
public : public :
Drive( http::Agent *http, const Json& options ) ; Drive( http::Agent *http, const Json& options, const std::string &rootFolder ) ;
void DetectChanges() ; void DetectChanges() ;
void Update() ; void Update() ;
@ -60,7 +60,7 @@ private :
http::Agent *m_http ; http::Agent *m_http ;
std::string m_resume_link ; std::string m_resume_link ;
State m_state ; State m_state ;
fs::path m_rootFolder;
Json m_options ; Json m_options ;
} ; } ;

View File

@ -58,8 +58,8 @@ const std::string xml_meta =
/// default constructor creates the root folder /// default constructor creates the root folder
Resource::Resource() : Resource::Resource(const fs::path& rootFolder) :
m_name ( "." ), m_name ( rootFolder.string() ),
m_kind ( "folder" ), m_kind ( "folder" ),
m_id ( "folder:root" ), m_id ( "folder:root" ),
m_href ( root_href ), m_href ( root_href ),

View File

@ -51,7 +51,7 @@ public :
typedef Children::const_iterator iterator ; typedef Children::const_iterator iterator ;
public : public :
Resource() ; Resource(const fs::path& rootFolder) ;
Resource( const std::string& name, const std::string& kind ) ; Resource( const std::string& name, const std::string& kind ) ;
// default copy ctor & op= are fine // default copy ctor & op= are fine

View File

@ -31,8 +31,8 @@ namespace gr {
using namespace details ; using namespace details ;
ResourceTree::ResourceTree( ) : ResourceTree::ResourceTree( const fs::path& rootFolder ) :
m_root( new Resource ) m_root(new Resource(rootFolder))
{ {
m_set.insert( m_root ) ; m_set.insert( m_root ) ;
} }

View File

@ -64,7 +64,7 @@ public :
typedef details::Set::iterator iterator ; typedef details::Set::iterator iterator ;
public : public :
ResourceTree( ) ; ResourceTree( const fs::path& rootFolder ) ;
ResourceTree( const ResourceTree& fs ) ; ResourceTree( const ResourceTree& fs ) ;
~ResourceTree( ) ; ~ResourceTree( ) ;

View File

@ -32,8 +32,9 @@
namespace gr { namespace gr {
State::State( const fs::path& filename, const Json& options ) : State::State( const fs::path& rootFolder, const fs::path& filename, const Json& options ) :
m_cstamp( -1 ) m_cstamp( -1 ),
m_res(rootFolder)
{ {
Read( filename ) ; Read( filename ) ;

View File

@ -43,7 +43,7 @@ public :
typedef ResourceTree::iterator iterator ; typedef ResourceTree::iterator iterator ;
public : public :
explicit State( const fs::path& filename, const Json& options ) ; explicit State( const fs::path& rootFolder, const fs::path& filename, const Json& options ) ;
~State() ; ~State() ;
void FromLocal( const fs::path& p ) ; void FromLocal( const fs::path& p ) ;

View File

@ -21,26 +21,28 @@
#include "util/StdioFile.hh" #include "util/StdioFile.hh"
#include <iostream>
#include <iterator> #include <iterator>
namespace gr { using namespace gr;
const std::string& Config::Filename() Config::Config(const fs::path& configFile)
: m_configFile(configFile)
, m_cfg( Read() )
{ {
static const char *env_cfg = ::getenv( "GR_CONFIG" ) ; if (configFile.empty()) {
static const std::string filename = (env_cfg != 0) ? env_cfg : ".grive" ; throw Error() << expt::ErrMsg("Config cannot be initalised with an empty string.");
}
return filename ;
} }
Config::Config() : const fs::path& Config::ConfigFile() const
m_cfg( Read( Filename() ) )
{ {
return m_configFile ;
} }
void Config::Save( ) void Config::Save( )
{ {
StdioFile file( Filename(), 0600 ) ; StdioFile file( m_configFile.string(), 0600 ) ;
m_cfg.Write( file ) ; m_cfg.Write( file ) ;
} }
@ -49,11 +51,11 @@ Json& Config::Get()
return m_cfg ; return m_cfg ;
} }
Json Config::Read( const std::string& filename ) Json Config::Read()
{ {
try try
{ {
return Json::ParseFile( filename ) ; return Json::ParseFile( m_configFile.string() ) ;
} }
catch ( Exception& e ) catch ( Exception& e )
{ {
@ -61,4 +63,3 @@ Json Config::Read( const std::string& filename )
} }
} }
} // end of namespace

View File

@ -19,7 +19,8 @@
#pragma once #pragma once
#include "util/Exception.hh" #include "Exception.hh"
#include "FileSystem.hh"
#include "protocol/Json.hh" #include "protocol/Json.hh"
namespace gr { namespace gr {
@ -30,17 +31,17 @@ public :
struct Error : virtual Exception {} ; struct Error : virtual Exception {} ;
typedef boost::error_info<struct FileTag, std::string> File ; typedef boost::error_info<struct FileTag, std::string> File ;
static const std::string& Filename() ; Config(const fs::path& configFile) ;
Config() ;
Json& Get() ; Json& Get() ;
void Save() ; void Save() ;
const fs::path &ConfigFile() const;
private : private :
Json Read( const std::string& filename ) ; Json Read() ;
private : private :
const fs::path m_configFile;
Json m_cfg ; Json m_cfg ;
} ; } ;

View File

@ -27,6 +27,7 @@
#include "drive/StateTest.hh" #include "drive/StateTest.hh"
#include "util/DateTimeTest.hh" #include "util/DateTimeTest.hh"
#include "util/FunctionTest.hh" #include "util/FunctionTest.hh"
#include "util/ConfigTest.hh"
#include "util/SignalHandlerTest.hh" #include "util/SignalHandlerTest.hh"
#include "xml/NodeTest.hh" #include "xml/NodeTest.hh"
@ -43,6 +44,7 @@ int main( int argc, char **argv )
runner.addTest( ResourceTreeTest::suite( ) ) ; runner.addTest( ResourceTreeTest::suite( ) ) ;
runner.addTest( DateTimeTest::suite( ) ) ; runner.addTest( DateTimeTest::suite( ) ) ;
runner.addTest( FunctionTest::suite( ) ) ; runner.addTest( FunctionTest::suite( ) ) ;
runner.addTest( ConfigTest::suite( ) ) ;
runner.addTest( SignalHandlerTest::suite( ) ) ; runner.addTest( SignalHandlerTest::suite( ) ) ;
runner.addTest( NodeTest::suite( ) ) ; runner.addTest( NodeTest::suite( ) ) ;
runner.run(); runner.run();

View File

@ -38,9 +38,10 @@ ResourceTest::ResourceTest( )
void ResourceTest::TestRootPath() void ResourceTest::TestRootPath()
{ {
Resource root ; std::string rootFolder = "/home/usr/grive/grive";
Resource root(rootFolder) ;
CPPUNIT_ASSERT( root.IsRoot() ) ; CPPUNIT_ASSERT( root.IsRoot() ) ;
GRUT_ASSERT_EQUAL( root.Path(), fs::path( "." ) ) ; GRUT_ASSERT_EQUAL( root.Path(), fs::path( rootFolder ) ) ;
} }
void ResourceTest::TestNormal( ) void ResourceTest::TestNormal( )
@ -60,7 +61,7 @@ void ResourceTest::TestNormal( )
Entry remote( entry ) ; Entry remote( entry ) ;
subject.FromRemote( remote, DateTime() ) ; subject.FromRemote( remote, DateTime() ) ;
GRUT_ASSERT_EQUAL( subject.StateStr(), "local_changed" ) ; GRUT_ASSERT_EQUAL( "local_changed", subject.StateStr() ) ;
} }

View File

@ -0,0 +1,57 @@
/*
grive: an GPL program to sync a local directory with Google Drive
Copyright (C) 2012 Wan Wai Ho
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 version 2
of the License.
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
#include "ConfigTest.hh"
#include "Assert.hh"
#include "util/Config.hh"
#include "protocol/Json.hh"
#include "util/log/Log.hh"
#include <iostream>
using namespace grut;
using namespace gr ;
ConfigTest::ConfigTest( )
{
}
void ConfigTest::TestInitialiseWithEmptyString( )
{
Config config("");
GRUT_ASSERT_EQUAL( "/home/.grive", config.ConfigFile().string()) ;
}
void ConfigTest::TestInitialiseWithString( )
{
Config config("/home/.grive");
GRUT_ASSERT_EQUAL( "/home/.grive", config.ConfigFile().string()) ;
}
void ConfigTest::TestInitialiseWithFileSystemPath( )
{
fs::path path("/home");
fs::path file(".grive");
Config config(path / file);
GRUT_ASSERT_EQUAL( "/home/.grive", config.ConfigFile().string());
}

View File

@ -0,0 +1,47 @@
/*
grive: an GPL program to sync a local directory with Google Drive
Copyright (C) 2012 Wan Wai Ho
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 version 2
of the License.
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
#pragma once
#include "util/Config.hh"
#include <cppunit/TestFixture.h>
#include <cppunit/extensions/HelperMacros.h>
namespace grut {
class ConfigTest : public CppUnit::TestFixture
{
public :
ConfigTest( ) ;
// declare suit function
CPPUNIT_TEST_SUITE( ConfigTest ) ;
CPPUNIT_TEST_EXCEPTION( TestInitialiseWithEmptyString, gr::Config::Error ) ;
CPPUNIT_TEST( TestInitialiseWithString ) ;
CPPUNIT_TEST( TestInitialiseWithFileSystemPath ) ;
CPPUNIT_TEST_SUITE_END();
private :
void TestInitialiseWithEmptyString( );
void TestInitialiseWithString( );
void TestInitialiseWithFileSystemPath( );
} ;
} // end of namespace