htsget-config 0.22.0

Used to configure htsget-rs by using a config file or reading environment variables.
Documentation 
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
126
127

//! Configuration for storage on AWS S3.
//!

#[cfg(feature = "experimental")]
use crate::storage::c4gh::C4GHKeys;
use schemars::JsonSchema;
use serde::{Deserialize, Serialize};

/// Configure the server to fetch data and return tickets from S3.
#[derive(JsonSchema, Serialize, Deserialize, Debug, Clone)]
#[serde(default, deny_unknown_fields)]
pub struct S3 {
  /// The bucket to use.
  bucket: String,
  /// The S3 endpoint to use.
  endpoint: Option<String>,
  /// Whether path style or virtual host addressing should be used.
  path_style: bool,
  /// Optional Crypt4GH keys to use when decrypting data.
  #[cfg(feature = "experimental")]
  #[serde(skip_serializing)]
  keys: Option<C4GHKeys>,
  #[serde(skip)]
  pub(crate) is_defaulted: bool,
}

impl Eq for S3 {}

impl PartialEq for S3 {
  fn eq(&self, other: &Self) -> bool {
    self.bucket == other.bucket
      && self.endpoint == other.endpoint
      && self.path_style == other.path_style
  }
}

impl S3 {
  /// Create a new S3 storage.
  pub fn new(bucket: String, endpoint: Option<String>, path_style: bool) -> Self {
    Self {
      bucket,
      endpoint,
      path_style,
      #[cfg(feature = "experimental")]
      keys: None,
      is_defaulted: false,
    }
  }

  /// Get the bucket.
  pub fn bucket(&self) -> &str {
    &self.bucket
  }

  /// Set the bucket.
  pub fn with_bucket(mut self, bucket: String) -> Self {
    self.bucket = bucket;
    self
  }

  /// Get the endpoint
  pub fn endpoint(&self) -> Option<&str> {
    self.endpoint.as_deref()
  }

  /// Set the endpoint.
  pub fn with_endpoint(mut self, endpoint: String) -> Self {
    self.endpoint = Some(endpoint);
    self
  }

  /// Get the path style
  pub fn path_style(&self) -> bool {
    self.path_style
  }

  /// Set the path style.
  pub fn with_path_style(mut self, path_style: bool) -> Self {
    self.path_style = path_style;
    self
  }

  #[cfg(feature = "experimental")]
  /// Set the C4GH keys.
  pub fn set_keys(&mut self, keys: Option<C4GHKeys>) {
    self.keys = keys;
  }

  #[cfg(feature = "experimental")]
  /// Get the C4GH keys.
  pub fn keys(&self) -> Option<&C4GHKeys> {
    self.keys.as_ref()
  }
}

impl Default for S3 {
  fn default() -> Self {
    let mut s3 = Self::new(Default::default(), Default::default(), Default::default());
    s3.is_defaulted = true;
    s3
  }
}

#[cfg(test)]
mod tests {
  use super::*;
  use crate::config::tests::test_serialize_and_deserialize;

  #[test]
  fn s3_backend() {
    test_serialize_and_deserialize(
      r#"
      bucket = "bucket"
      endpoint = "127.0.0.1:8083"
      path_style = true
      "#,
      ("127.0.0.1:8083".to_string(), "bucket".to_string(), true),
      |result: S3| {
        (
          result.endpoint.unwrap().to_string(),
          result.bucket.to_string(),
          result.path_style,
        )
      },
    );
  }
}