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