use derive_builder::Builder;
use crate::api::common::NameOrId;
use crate::api::endpoint_prelude::*;
use crate::api::ParamValue;
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[non_exhaustive]
pub enum ProjectVariableType {
EnvVar,
File,
}
impl ProjectVariableType {
fn as_str(self) -> &'static str {
match self {
ProjectVariableType::EnvVar => "env_var",
ProjectVariableType::File => "file",
}
}
}
impl ParamValue<'static> for ProjectVariableType {
fn as_value(&self) -> Cow<'static, str> {
self.as_str().into()
}
}
#[derive(Debug, Builder, Clone)]
#[builder(setter(strip_option))]
pub struct CreateProjectVariable<'a> {
#[builder(setter(into))]
project: NameOrId<'a>,
#[builder(setter(into))]
key: Cow<'a, str>,
#[builder(setter(into))]
value: Cow<'a, str>,
#[builder(default)]
variable_type: Option<ProjectVariableType>,
#[builder(default)]
protected: Option<bool>,
#[builder(default)]
masked: Option<bool>,
#[builder(default)]
raw: Option<bool>,
#[builder(setter(into), default)]
environment_scope: Option<Cow<'a, str>>,
#[builder(setter(into), default)]
description: Option<Cow<'a, str>>,
}
impl<'a> CreateProjectVariable<'a> {
pub fn builder() -> CreateProjectVariableBuilder<'a> {
CreateProjectVariableBuilder::default()
}
}
impl<'a> Endpoint for CreateProjectVariable<'a> {
fn method(&self) -> Method {
Method::POST
}
fn endpoint(&self) -> Cow<'static, str> {
format!("projects/{}/variables", self.project).into()
}
fn body(&self) -> Result<Option<(&'static str, Vec<u8>)>, BodyError> {
let mut params = FormParams::default();
params
.push("key", &self.key)
.push("value", &self.value)
.push_opt("variable_type", self.variable_type)
.push_opt("protected", self.protected)
.push_opt("masked", self.masked)
.push_opt("raw", self.raw)
.push_opt("environment_scope", self.environment_scope.as_ref())
.push_opt("description", self.description.as_ref());
params.into_body()
}
}
#[cfg(test)]
mod tests {
use http::Method;
use crate::api::projects::variables::create::{
CreateProjectVariable, CreateProjectVariableBuilderError, ProjectVariableType,
};
use crate::api::{self, Query};
use crate::test::client::{ExpectedUrl, SingleTestClient};
#[test]
fn project_variable_type_as_str() {
let items = &[
(ProjectVariableType::EnvVar, "env_var"),
(ProjectVariableType::File, "file"),
];
for (i, s) in items {
assert_eq!(i.as_str(), *s);
}
}
#[test]
fn all_parameters_are_needed() {
let err = CreateProjectVariable::builder().build().unwrap_err();
crate::test::assert_missing_field!(err, CreateProjectVariableBuilderError, "project");
}
#[test]
fn project_is_necessary() {
let err = CreateProjectVariable::builder()
.key("testkey")
.value("testvalue")
.build()
.unwrap_err();
crate::test::assert_missing_field!(err, CreateProjectVariableBuilderError, "project");
}
#[test]
fn key_is_necessary() {
let err = CreateProjectVariable::builder()
.project(1)
.value("testvalue")
.build()
.unwrap_err();
crate::test::assert_missing_field!(err, CreateProjectVariableBuilderError, "key");
}
#[test]
fn value_level_is_necessary() {
let err = CreateProjectVariable::builder()
.project(1)
.key("testkey")
.build()
.unwrap_err();
crate::test::assert_missing_field!(err, CreateProjectVariableBuilderError, "value");
}
#[test]
fn sufficient_parameters() {
CreateProjectVariable::builder()
.project(1)
.key("testkey")
.value("testvalue")
.build()
.unwrap();
}
#[test]
fn endpoint() {
let endpoint = ExpectedUrl::builder()
.method(Method::POST)
.endpoint("projects/simple%2Fproject/variables")
.content_type("application/x-www-form-urlencoded")
.body_str(concat!("key=testkey", "&value=testvalue"))
.build()
.unwrap();
let client = SingleTestClient::new_raw(endpoint, "");
let endpoint = CreateProjectVariable::builder()
.project("simple/project")
.key("testkey")
.value("testvalue")
.build()
.unwrap();
api::ignore(endpoint).query(&client).unwrap();
}
#[test]
fn endpoint_variable_type() {
let endpoint = ExpectedUrl::builder()
.method(Method::POST)
.endpoint("projects/simple%2Fproject/variables")
.content_type("application/x-www-form-urlencoded")
.body_str(concat!(
"key=testkey",
"&value=testvalue",
"&variable_type=file"
))
.build()
.unwrap();
let client = SingleTestClient::new_raw(endpoint, "");
let endpoint = CreateProjectVariable::builder()
.project("simple/project")
.key("testkey")
.value("testvalue")
.variable_type(ProjectVariableType::File)
.build()
.unwrap();
api::ignore(endpoint).query(&client).unwrap();
}
#[test]
fn endpoint_protected() {
let endpoint = ExpectedUrl::builder()
.method(Method::POST)
.endpoint("projects/simple%2Fproject/variables")
.content_type("application/x-www-form-urlencoded")
.body_str(concat!(
"key=testkey",
"&value=testvalue",
"&protected=true"
))
.build()
.unwrap();
let client = SingleTestClient::new_raw(endpoint, "");
let endpoint = CreateProjectVariable::builder()
.project("simple/project")
.key("testkey")
.value("testvalue")
.protected(true)
.build()
.unwrap();
api::ignore(endpoint).query(&client).unwrap();
}
#[test]
fn endpoint_masked() {
let endpoint = ExpectedUrl::builder()
.method(Method::POST)
.endpoint("projects/simple%2Fproject/variables")
.content_type("application/x-www-form-urlencoded")
.body_str(concat!("key=testkey", "&value=testvalue", "&masked=true"))
.build()
.unwrap();
let client = SingleTestClient::new_raw(endpoint, "");
let endpoint = CreateProjectVariable::builder()
.project("simple/project")
.key("testkey")
.value("testvalue")
.masked(true)
.build()
.unwrap();
api::ignore(endpoint).query(&client).unwrap();
}
#[test]
fn endpoint_raw() {
let endpoint = ExpectedUrl::builder()
.method(Method::POST)
.endpoint("projects/simple%2Fproject/variables")
.content_type("application/x-www-form-urlencoded")
.body_str(concat!("key=testkey", "&value=testvalue", "&raw=true"))
.build()
.unwrap();
let client = SingleTestClient::new_raw(endpoint, "");
let endpoint = CreateProjectVariable::builder()
.project("simple/project")
.key("testkey")
.value("testvalue")
.raw(true)
.build()
.unwrap();
api::ignore(endpoint).query(&client).unwrap();
}
#[test]
fn endpoint_environment_scope() {
let endpoint = ExpectedUrl::builder()
.method(Method::POST)
.endpoint("projects/simple%2Fproject/variables")
.content_type("application/x-www-form-urlencoded")
.body_str(concat!(
"key=testkey",
"&value=testvalue",
"&environment_scope=*"
))
.build()
.unwrap();
let client = SingleTestClient::new_raw(endpoint, "");
let endpoint = CreateProjectVariable::builder()
.project("simple/project")
.key("testkey")
.value("testvalue")
.environment_scope("*")
.build()
.unwrap();
api::ignore(endpoint).query(&client).unwrap();
}
#[test]
fn endpoint_description() {
let endpoint = ExpectedUrl::builder()
.method(Method::POST)
.endpoint("projects/simple%2Fproject/variables")
.content_type("application/x-www-form-urlencoded")
.body_str(concat!(
"key=testkey",
"&value=testvalue",
"&description=desc"
))
.build()
.unwrap();
let client = SingleTestClient::new_raw(endpoint, "");
let endpoint = CreateProjectVariable::builder()
.project("simple/project")
.key("testkey")
.value("testvalue")
.description("desc")
.build()
.unwrap();
api::ignore(endpoint).query(&client).unwrap();
}
}