include/mesos/appc/spec.hpp

// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License.  You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#ifndef __PROVISIONER_APPC_SPEC_HPP__
#define __PROVISIONER_APPC_SPEC_HPP__

#include <string>

#include <stout/error.hpp>
#include <stout/option.hpp>
#include <stout/try.hpp>

#include <mesos/appc/spec.pb.h>

namespace appc {
namespace spec {

// Parse the ImageManifest in the specified JSON string.
Try<ImageManifest> parse(const std::string& value);


// Returns the rootfs of an image, given its path as per the spec.
std::string getImageRootfsPath(const std::string& imagePath);


// Returns the path of an image's manifest, given its path as per the spec.
std::string getImageManifestPath(const std::string& imagePath);


// Returns ImageManifest object for an image at given path.
Try<ImageManifest> getManifest(const std::string& imagePath);


// Validate if the specified image manifest conforms to the Appc spec.
Option<Error> validateManifest(const ImageManifest& manifest);


// Validate if the specified image ID conforms to the Appc spec.
Option<Error> validateImageID(const std::string& imageId);


// Validate if the specified image has the disk layout that conforms
// to the Appc spec.
Option<Error> validateLayout(const std::string& imagePath);


// Validates the image path if it conforms to the Appc image spec.
Option<Error> validate(const std::string& imageDir);

} // namespace spec {
} // namespace appc {

#endif // __PROVISIONER_APPC_SPEC_HPP__