File size: 3,795 Bytes
2492322 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 | // Copyright (c) 2022, QuantStack and Mamba Contributors
//
// Distributed under the terms of the BSD 3-Clause License.
//
// The full license is in the file LICENSE, distributed with this software.
#ifndef MAMBA_CORE_ENVIRONMENT_LOCKFILE_HPP
#define MAMBA_CORE_ENVIRONMENT_LOCKFILE_HPP
#include <optional>
#include <string>
#include <typeindex>
#include <unordered_map>
#include <tl/expected.hpp>
#include "mamba/core/error_handling.hpp"
#include "mamba/core/fsutil.hpp"
#include "mamba/fs/filesystem.hpp"
#include "mamba/specs/package_info.hpp"
namespace mamba
{
class Context;
class ChannelContext;
enum class file_parsing_error_code
{
unknown_failure, /// Something failed while parsing but we can't identify what.
unsupported_version, /// The version of the file does not matched supported ver.
parsing_failure, /// The content of the file doesnt match the expected format/language
/// structure or constraints.
invalid_data, /// The structure of the data in the file is fine but some fields have
/// invalid values for our purpose.
};
struct EnvLockFileError
{
file_parsing_error_code parsing_error_code = file_parsing_error_code::unknown_failure;
std::optional<std::type_index> yaml_error_type{};
static const EnvLockFileError& get_details(const mamba_error& error)
{
return std::any_cast<const EnvLockFileError&>(error.data());
}
template <typename StringT>
static mamba_error make_error(
file_parsing_error_code error_code,
StringT&& msg,
std::optional<std::type_index> yaml_error_type = std::nullopt
)
{
return mamba_error{ std::forward<StringT>(msg),
mamba_error_code::env_lockfile_parsing_failed,
EnvLockFileError{ error_code, yaml_error_type } };
}
};
class EnvironmentLockFile
{
public:
struct Channel
{
std::string url;
std::vector<std::string> used_env_vars;
};
struct Meta
{
std::unordered_map<std::string, std::string> content_hash;
std::vector<Channel> channels;
std::vector<std::string> platforms;
std::vector<std::string> sources;
};
struct Package
{
specs::PackageInfo info;
bool is_optional = false;
std::string category;
std::string manager;
std::string platform;
};
EnvironmentLockFile(Meta metadata, std::vector<Package> packages)
: m_metadata(std::move(metadata))
, m_packages(std::move(packages))
{
}
std::vector<specs::PackageInfo>
get_packages_for(std::string_view category, std::string_view platform, std::string_view manager)
const;
const std::vector<Package>& get_all_packages() const
{
return m_packages;
}
const Meta& get_metadata() const
{
return m_metadata;
}
private:
Meta m_metadata;
std::vector<Package> m_packages;
};
/// Read an environment lock YAML file and returns it's structured content or an error if
/// failed.
tl::expected<EnvironmentLockFile, mamba_error>
read_environment_lockfile(const mamba::fs::u8path& lockfile_location);
/// Returns `true` if the filename matches names of files which should be interpreted as conda
/// environment lockfile. NOTE: this does not check if the file exists.
bool is_env_lockfile_name(std::string_view filename);
}
#endif
|