1
// Licensed to the Software Freedom Conservancy (SFC) under one
2
// or more contributor license agreements.  See the NOTICE file
3
// distributed with this work for additional information
4
// regarding copyright ownership.  The SFC licenses this file
5
// to you under the Apache License, Version 2.0 (the
6
// "License"); you may not use this file except in compliance
7
// with the License.  You may obtain a copy of the License at
8
//
9
//   http://www.apache.org/licenses/LICENSE-2.0
10
//
11
// Unless required by applicable law or agreed to in writing,
12
// software distributed under the License is distributed on an
13
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14
// KIND, either express or implied.  See the License for the
15
// specific language governing permissions and limitations
16
// under the License.
17

18
use crate::config::ManagerConfig;
19
use crate::downloads::parse_json_from_url;
20
use crate::files::BrowserPath;
21
use crate::metadata::{
22
    create_driver_metadata, get_driver_version_from_metadata, get_metadata, write_metadata,
23
};
24
use crate::mirror::{Assets, SeleniumRelease, MIRROR_URL};
25
use crate::{
26
    create_http_client, parse_version, Logger, SeleniumManager, OFFLINE_REQUEST_ERR_MSG, SNAPSHOT,
27
};
28
use anyhow::anyhow;
29
use anyhow::Error;
30
use reqwest::Client;
31
use std::collections::HashMap;
32
use std::path::PathBuf;
33
use std::sync::mpsc;
34
use std::sync::mpsc::{Receiver, Sender};
35

36
pub const GRID_NAME: &str = "grid";
37
const GRID_RELEASE: &str = "selenium-server";
38
const GRID_EXTENSION: &str = "jar";
39
const DRIVER_URL: &str = "https://github.com/SeleniumHQ/selenium/releases/";
40

41
// Although Selenium Grid is not a browser, we can use the same manager struct, where:
42
// - browser_name refers to the product name, i.e., grid
43
// - driver_name refers to the downloadable artifact, i.e., selenium-server (.jar)
44
pub struct GridManager {
45
    pub browser_name: &'static str,
46
    pub driver_name: &'static str,
47
    pub config: ManagerConfig,
48
    pub http_client: Client,
49
    pub log: Logger,
50
    pub tx: Sender<String>,
51
    pub rx: Receiver<String>,
52
    pub download_browser: bool,
53
    pub driver_url: Option<String>,
54
}
55

56
impl GridManager {
57
    pub fn new(driver_version: String) -> Result<Box<Self>, Error> {
58
        let browser_name = GRID_NAME;
59
        let driver_name = GRID_RELEASE;
60
        let mut config = ManagerConfig::default(browser_name, driver_name);
61
        config.driver_version = driver_version;
62
        let default_timeout = config.timeout.to_owned();
63
        let default_proxy = &config.proxy;
64
        let (tx, rx): (Sender<String>, Receiver<String>) = mpsc::channel();
65
        Ok(Box::new(GridManager {
66
            browser_name,
67
            driver_name,
68
            http_client: create_http_client(default_timeout, default_proxy)?,
69
            config,
70
            log: Logger::new(),
71
            tx,
72
            rx,
73
            download_browser: false,
74
            driver_url: None,
75
        }))
76
    }
77
}
78

79
impl SeleniumManager for GridManager {
80
    fn get_browser_name(&self) -> &str {
81
        self.browser_name
82
    }
83

84
    fn get_browser_names_in_path(&self) -> Vec<&str> {
85
        vec![self.get_browser_name()]
86
    }
87

88
    fn get_http_client(&self) -> &Client {
89
        &self.http_client
90
    }
91

92
    fn set_http_client(&mut self, http_client: Client) {
93
        self.http_client = http_client;
94
    }
95

96
    fn get_browser_path_map(&self) -> HashMap<BrowserPath, &str> {
97
        HashMap::new()
98
    }
99

100
    fn discover_browser_version(&mut self) -> Result<Option<String>, Error> {
101
        Ok(None)
102
    }
103

104
    fn get_driver_name(&self) -> &str {
105
        self.driver_name
106
    }
107

108
    fn request_driver_version(&mut self) -> Result<String, Error> {
109
        let is_nightly = self.is_nightly(self.get_driver_version());
110
        let major_driver_version_binding = self.get_major_driver_version();
111
        let major_driver_version = major_driver_version_binding.as_str();
112
        let cache_path = self.get_cache_path()?;
113
        let mut metadata = get_metadata(self.get_logger(), &cache_path);
114

115
        match get_driver_version_from_metadata(
116
            &metadata.drivers,
117
            self.driver_name,
118
            major_driver_version,
119
        ) {
120
            Some(driver_version) => {
121
                self.log.trace(format!(
122
                    "Driver TTL is valid. Getting {} version from metadata",
123
                    &self.driver_name
124
                ));
125
                Ok(driver_version)
126
            }
127
            _ => {
128
                self.assert_online_or_err(OFFLINE_REQUEST_ERR_MSG)?;
129

130
                let selenium_releases = parse_json_from_url::<Vec<SeleniumRelease>>(
131
                    self.get_http_client(),
132
                    MIRROR_URL,
133
                )?;
134

135
                let filtered_releases: Vec<SeleniumRelease> = selenium_releases
136
                    .into_iter()
137
                    .filter(|r| {
138
                        r.assets.iter().any(|url| {
139
                            if is_nightly {
140
                                url.browser_download_url.contains(SNAPSHOT)
141
                            } else {
142
                                url.browser_download_url.contains(GRID_RELEASE)
143
                                    && !url.browser_download_url.contains(SNAPSHOT)
144
                            }
145
                        })
146
                    })
147
                    .collect();
148

149
                if !filtered_releases.is_empty() {
150
                    let assets = &filtered_releases.first().unwrap().assets;
151
                    let driver_releases: Vec<&Assets> = assets
152
                        .iter()
153
                        .filter(|url| {
154
                            url.browser_download_url.contains(GRID_RELEASE)
155
                                && url.browser_download_url.contains(GRID_EXTENSION)
156
                        })
157
                        .collect();
158
                    let driver_url = &driver_releases.last().unwrap().browser_download_url;
159
                    self.driver_url = Some(driver_url.to_string());
160

161
                    let index_release =
162
                        driver_url.rfind(GRID_RELEASE).unwrap() + GRID_RELEASE.len() + 1;
163
                    let driver_version = if is_nightly {
164
                        let index_jar = driver_url.rfind(GRID_EXTENSION).unwrap() - 1;
165
                        driver_url.as_str()[index_release..index_jar].to_string()
166
                    } else {
167
                        parse_version(
168
                            driver_url.as_str()[index_release..].to_string(),
169
                            self.get_logger(),
170
                        )?
171
                    };
172

173
                    let driver_ttl = self.get_ttl();
174
                    if driver_ttl > 0 {
175
                        metadata.drivers.push(create_driver_metadata(
176
                            major_driver_version,
177
                            self.driver_name,
178
                            &driver_version,
179
                            driver_ttl,
180
                        ));
181
                        write_metadata(&metadata, self.get_logger(), cache_path);
182
                    }
183

184
                    Ok(driver_version)
185
                } else {
186
                    Err(anyhow!(format!(
187
                        "{} release not available",
188
                        self.get_driver_name()
189
                    )))
190
                }
191
            }
192
        }
193
    }
194

195
    fn request_browser_version(&mut self) -> Result<Option<String>, Error> {
196
        Ok(None)
197
    }
198

199
    fn get_driver_url(&mut self) -> Result<String, Error> {
200
        if self.driver_url.is_some() {
201
            return Ok(self.driver_url.as_ref().unwrap().to_string());
202
        }
203

204
        let release_version = self.get_selenium_release_version()?;
205
        Ok(format!(
206
            "{}download/{}/{}-{}.{}",
207
            self.get_driver_mirror_url_or_default(DRIVER_URL),
208
            release_version,
209
            GRID_RELEASE,
210
            self.get_driver_version(),
211
            GRID_EXTENSION
212
        ))
213
    }
214

215
    fn get_driver_path_in_cache(&self) -> Result<PathBuf, Error> {
216
        let browser_name = self.get_browser_name();
217
        let driver_name = self.get_driver_name();
218
        let driver_version = self.get_driver_version();
219
        Ok(self
220
            .get_cache_path()?
221
            .unwrap_or_default()
222
            .join(browser_name)
223
            .join(driver_version)
224
            .join(format!("{driver_name}-{driver_version}.{GRID_EXTENSION}")))
225
    }
226

227
    fn get_config(&self) -> &ManagerConfig {
228
        &self.config
229
    }
230

231
    fn get_config_mut(&mut self) -> &mut ManagerConfig {
232
        &mut self.config
233
    }
234

235
    fn set_config(&mut self, config: ManagerConfig) {
236
        self.config = config;
237
    }
238

239
    fn get_logger(&self) -> &Logger {
240
        &self.log
241
    }
242

243
    fn set_logger(&mut self, log: Logger) {
244
        self.log = log;
245
    }
246

247
    fn get_sender(&self) -> &Sender<String> {
248
        &self.tx
249
    }
250

251
    fn get_receiver(&self) -> &Receiver<String> {
252
        &self.rx
253
    }
254

255
    fn get_platform_label(&self) -> &str {
256
        ""
257
    }
258

259
    fn request_latest_browser_version_from_online(
260
        &mut self,
261
        _browser_version: &str,
262
    ) -> Result<String, Error> {
263
        self.unavailable_download()
264
    }
265

266
    fn request_fixed_browser_version_from_online(
267
        &mut self,
268
        _browser_version: &str,
269
    ) -> Result<String, Error> {
270
        self.unavailable_download()
271
    }
272

273
    fn get_min_browser_version_for_download(&self) -> Result<i32, Error> {
274
        self.unavailable_download()
275
    }
276

277
    fn get_browser_binary_path(&mut self, _browser_version: &str) -> Result<PathBuf, Error> {
278
        self.unavailable_download()
279
    }
280

281
    fn get_browser_url_for_download(&mut self, _browser_version: &str) -> Result<String, Error> {
282
        self.unavailable_download()
283
    }
284

285
    fn get_browser_label_for_download(
286
        &self,
287
        _browser_version: &str,
288
    ) -> Result<Option<&str>, Error> {
289
        self.unavailable_download()
290
    }
291

292
    fn is_download_browser(&self) -> bool {
293
        self.download_browser
294
    }
295

296
    fn set_download_browser(&mut self, download_browser: bool) {
297
        self.download_browser = download_browser;
298
    }
299

300
    fn is_snap(&self, _browser_path: &str) -> bool {
301
        false
302
    }
303

304
    fn get_snap_path(&self) -> Option<PathBuf> {
305
        None
306
    }
307
}
308

309