1*b0d29bc4SBrooks Davis // Copyright 2014 The Kyua Authors. 2*b0d29bc4SBrooks Davis // All rights reserved. 3*b0d29bc4SBrooks Davis // 4*b0d29bc4SBrooks Davis // Redistribution and use in source and binary forms, with or without 5*b0d29bc4SBrooks Davis // modification, are permitted provided that the following conditions are 6*b0d29bc4SBrooks Davis // met: 7*b0d29bc4SBrooks Davis // 8*b0d29bc4SBrooks Davis // * Redistributions of source code must retain the above copyright 9*b0d29bc4SBrooks Davis // notice, this list of conditions and the following disclaimer. 10*b0d29bc4SBrooks Davis // * Redistributions in binary form must reproduce the above copyright 11*b0d29bc4SBrooks Davis // notice, this list of conditions and the following disclaimer in the 12*b0d29bc4SBrooks Davis // documentation and/or other materials provided with the distribution. 13*b0d29bc4SBrooks Davis // * Neither the name of Google Inc. nor the names of its contributors 14*b0d29bc4SBrooks Davis // may be used to endorse or promote products derived from this software 15*b0d29bc4SBrooks Davis // without specific prior written permission. 16*b0d29bc4SBrooks Davis // 17*b0d29bc4SBrooks Davis // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 18*b0d29bc4SBrooks Davis // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 19*b0d29bc4SBrooks Davis // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 20*b0d29bc4SBrooks Davis // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 21*b0d29bc4SBrooks Davis // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 22*b0d29bc4SBrooks Davis // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 23*b0d29bc4SBrooks Davis // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 24*b0d29bc4SBrooks Davis // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 25*b0d29bc4SBrooks Davis // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 26*b0d29bc4SBrooks Davis // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 27*b0d29bc4SBrooks Davis // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 28*b0d29bc4SBrooks Davis 29*b0d29bc4SBrooks Davis /// \file store/layout.hpp 30*b0d29bc4SBrooks Davis /// File system layout definition for the Kyua data files. 31*b0d29bc4SBrooks Davis /// 32*b0d29bc4SBrooks Davis /// Tests results files are all stored in a centralized directory by default. 33*b0d29bc4SBrooks Davis /// In the general case, we do not want the user to have to worry about files: 34*b0d29bc4SBrooks Davis /// we expose an identifier-based interface where each tests results file has a 35*b0d29bc4SBrooks Davis /// unique identifier. However, we also want to give full freedom to the user 36*b0d29bc4SBrooks Davis /// to store such files wherever he likes so we have to deal with paths as well. 37*b0d29bc4SBrooks Davis /// 38*b0d29bc4SBrooks Davis /// When creating a new results file, the inputs to resolve the path can be: 39*b0d29bc4SBrooks Davis /// - NEW: Automatic generation of a new results file, so we want to return its 40*b0d29bc4SBrooks Davis /// public identifier and the path for internal consumption. 41*b0d29bc4SBrooks Davis /// - A path: The user provided the specific location where he wants the file 42*b0d29bc4SBrooks Davis /// stored, so we just obey that. There is no public identifier in this case 43*b0d29bc4SBrooks Davis /// because there is no naming scheme imposed on the generated files. 44*b0d29bc4SBrooks Davis /// 45*b0d29bc4SBrooks Davis /// When opening an existing results file, the inputs to resolve the path can 46*b0d29bc4SBrooks Davis /// be: 47*b0d29bc4SBrooks Davis /// - LATEST: Given the current directory, we derive the corresponding test 48*b0d29bc4SBrooks Davis /// suite name and find the latest timestamped file in the centralized 49*b0d29bc4SBrooks Davis /// location. 50*b0d29bc4SBrooks Davis /// - A path: If the file exists, we just open that. If it doesn't exist or if 51*b0d29bc4SBrooks Davis /// it is a directory, we try to resolve that as a test suite name and locate 52*b0d29bc4SBrooks Davis /// the latest matching timestamped file. 53*b0d29bc4SBrooks Davis /// - Everything else: Treated as a test suite identifier, so we try to locate 54*b0d29bc4SBrooks Davis /// the latest matchin timestamped file. 55*b0d29bc4SBrooks Davis 56*b0d29bc4SBrooks Davis #if !defined(STORE_LAYOUT_HPP) 57*b0d29bc4SBrooks Davis #define STORE_LAYOUT_HPP 58*b0d29bc4SBrooks Davis 59*b0d29bc4SBrooks Davis #include "store/layout_fwd.hpp" 60*b0d29bc4SBrooks Davis 61*b0d29bc4SBrooks Davis #include <string> 62*b0d29bc4SBrooks Davis 63*b0d29bc4SBrooks Davis #include "utils/datetime_fwd.hpp" 64*b0d29bc4SBrooks Davis #include "utils/fs/path_fwd.hpp" 65*b0d29bc4SBrooks Davis 66*b0d29bc4SBrooks Davis namespace store { 67*b0d29bc4SBrooks Davis namespace layout { 68*b0d29bc4SBrooks Davis 69*b0d29bc4SBrooks Davis 70*b0d29bc4SBrooks Davis extern const char* results_auto_create_name; 71*b0d29bc4SBrooks Davis extern const char* results_auto_open_name; 72*b0d29bc4SBrooks Davis 73*b0d29bc4SBrooks Davis utils::fs::path find_results(const std::string&); 74*b0d29bc4SBrooks Davis results_id_file_pair new_db(const std::string&, const utils::fs::path&); 75*b0d29bc4SBrooks Davis utils::fs::path new_db_for_migration(const utils::fs::path&, 76*b0d29bc4SBrooks Davis const utils::datetime::timestamp&); 77*b0d29bc4SBrooks Davis utils::fs::path query_store_dir(void); 78*b0d29bc4SBrooks Davis std::string test_suite_for_path(const utils::fs::path&); 79*b0d29bc4SBrooks Davis 80*b0d29bc4SBrooks Davis 81*b0d29bc4SBrooks Davis } // namespace layout 82*b0d29bc4SBrooks Davis } // namespace store 83*b0d29bc4SBrooks Davis 84*b0d29bc4SBrooks Davis #endif // !defined(STORE_LAYOUT_HPP) 85