build.rs

/*
   Copyright The containerd Authors.

   Licensed 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.
*/

use std::{env, fs, io};

const PROTO_FILES: &[&str] = &[
    // Types
    "vendor/github.com/containerd/containerd/api/types/descriptor.proto",
    "vendor/github.com/containerd/containerd/api/types/metrics.proto",
    "vendor/github.com/containerd/containerd/api/types/mount.proto",
    "vendor/github.com/containerd/containerd/api/types/platform.proto",
    "vendor/github.com/containerd/containerd/api/types/sandbox.proto",
    "vendor/github.com/containerd/containerd/api/types/task/task.proto",
    "vendor/github.com/containerd/containerd/api/types/transfer/imagestore.proto",
    "vendor/github.com/containerd/containerd/api/types/transfer/importexport.proto",
    "vendor/github.com/containerd/containerd/api/types/transfer/progress.proto",
    "vendor/github.com/containerd/containerd/api/types/transfer/registry.proto",
    "vendor/github.com/containerd/containerd/api/types/transfer/streaming.proto",
    // Services
    "vendor/github.com/containerd/containerd/api/services/containers/v1/containers.proto",
    "vendor/github.com/containerd/containerd/api/services/content/v1/content.proto",
    "vendor/github.com/containerd/containerd/api/services/diff/v1/diff.proto",
    "vendor/github.com/containerd/containerd/api/services/events/v1/events.proto",
    "vendor/github.com/containerd/containerd/api/services/images/v1/images.proto",
    "vendor/github.com/containerd/containerd/api/services/introspection/v1/introspection.proto",
    "vendor/github.com/containerd/containerd/api/services/leases/v1/leases.proto",
    "vendor/github.com/containerd/containerd/api/services/namespaces/v1/namespace.proto",
    "vendor/github.com/containerd/containerd/api/services/sandbox/v1/sandbox.proto",
    "vendor/github.com/containerd/containerd/api/services/snapshots/v1/snapshots.proto",
    "vendor/github.com/containerd/containerd/api/services/streaming/v1/streaming.proto",
    "vendor/github.com/containerd/containerd/api/services/tasks/v1/tasks.proto",
    "vendor/github.com/containerd/containerd/api/services/transfer/v1/transfer.proto",
    "vendor/github.com/containerd/containerd/api/services/version/v1/version.proto",
    // Events
    "vendor/github.com/containerd/containerd/api/events/container.proto",
    "vendor/github.com/containerd/containerd/api/events/content.proto",
    "vendor/github.com/containerd/containerd/api/events/image.proto",
    "vendor/github.com/containerd/containerd/api/events/namespace.proto",
    "vendor/github.com/containerd/containerd/api/events/snapshot.proto",
    "vendor/github.com/containerd/containerd/api/events/task.proto",
];

const FIXUP_MODULES: &[&str] = &[
    "containerd.services.diff.v1",
    "containerd.services.images.v1",
    "containerd.services.introspection.v1",
    "containerd.services.sandbox.v1",
    "containerd.services.snapshots.v1",
    "containerd.services.tasks.v1",
    "containerd.services.containers.v1",
    "containerd.services.content.v1",
    "containerd.services.events.v1",
];

fn main() {
    let mut config = prost_build::Config::new();
    config.protoc_arg("--experimental_allow_proto3_optional");
    config.enable_type_names();

    tonic_build::configure()
        .build_server(false)
        .compile_protos_with_config(config, PROTO_FILES, &["vendor/"])
        .expect("Failed to generate GRPC bindings");

    for module in FIXUP_MODULES {
        fixup_imports(module).expect("Failed to fixup module");
    }
}

// Original containerd's protobuf files contain Go style imports:
// import "github.com/containerd/containerd/api/types/mount.proto";
//
// Tonic produces invalid code for these imports:
// error[E0433]: failed to resolve: there are too many leading `super` keywords
//   --> /containerd-rust-extensions/target/debug/build/containerd-client-protos-0a328c0c63f60cd0/out/containerd.services.diff.v1.rs:47:52
//    |
// 47 |     pub diff: ::core::option::Option<super::super::super::types::Descriptor>,
//    |                                                    ^^^^^ there are too many leading `super` keywords
//
// This func fixes imports to crate level ones, like `crate::types::Mount`
fn fixup_imports(path: &str) -> Result<(), io::Error> {
    let out_dir = env::var("OUT_DIR").unwrap();
    let path = format!("{}/{}.rs", out_dir, path);

    let contents = fs::read_to_string(&path)?
        .replace("super::super::super::v1::types", "crate::types::v1") // for tasks service
        .replace("super::super::super::super::types", "crate::types")
        .replace("super::super::super::types", "crate::types")
        .replace("super::super::super::super::google", "crate::google")
        .replace(
            "/// 	filters\\[0\\] or filters\\[1\\] or ... or filters\\[n-1\\] or filters\\[n\\]",
            r#"
            /// ```notrust
            /// 	filters[0] or filters[1] or ... or filters[n-1] or filters[n]
            /// ```"#,
        );
    fs::write(path, contents)?;
    Ok(())
}