aboutsummaryrefslogtreecommitdiffhomepage
path: root/crates/shirabe/tests/util/github_test.rs
blob: 10b5dd7bc69d5b4427ebbfc52e9294310b9cb7bb (plain)
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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
//! ref: composer/tests/Composer/Test/Util/GitHubTest.php

use std::cell::RefCell;
use std::rc::Rc;

use shirabe::config::{Config, ConfigSourceInterface};
use shirabe::io::IOInterface;
use shirabe::io::io_interface;
use shirabe::util::GitHub;
use shirabe::util::http_downloader::{HttpDownloader, HttpDownloaderMockHandler};
use shirabe_php_shim::PhpMixed;

use crate::config_stub::ConfigStubBuilder;
use crate::http_downloader_mock::{expect_full, get_http_downloader_mock};
use crate::io_mock::{Expectation, IOMock, get_io_mock};

const PASSWORD: &str = "password";
const MESSAGE: &str = "mymessage";
const ORIGIN: &str = "github.com";

// Records the config setting names a source has had removed, plus a fixed getName,
// mirroring GitHubTest's JsonConfigSource mocks (getName -> "auth.json", and the
// config source stubbing removeConfigSetting('github-oauth.<origin>')).
#[derive(Debug)]
struct ConfigSourceMock {
    name: String,
    removed: Rc<RefCell<Vec<String>>>,
}

impl ConfigSourceMock {
    fn new(name: &str) -> (Box<Self>, Rc<RefCell<Vec<String>>>) {
        let removed = Rc::new(RefCell::new(Vec::new()));
        (
            Box::new(Self {
                name: name.to_string(),
                removed: removed.clone(),
            }),
            removed,
        )
    }
}

impl ConfigSourceInterface for ConfigSourceMock {
    fn add_repository(
        &mut self,
        _name: &str,
        _config: PhpMixed,
        _append: bool,
    ) -> anyhow::Result<()> {
        unreachable!()
    }
    fn insert_repository(
        &mut self,
        _name: &str,
        _config: PhpMixed,
        _reference_name: &str,
        _offset: i64,
    ) -> anyhow::Result<()> {
        unreachable!()
    }
    fn set_repository_url(&mut self, _name: &str, _url: &str) -> anyhow::Result<()> {
        unreachable!()
    }
    fn remove_repository(&mut self, _name: &str) -> anyhow::Result<()> {
        unreachable!()
    }
    fn add_config_setting(&mut self, _name: &str, _value: PhpMixed) -> anyhow::Result<()> {
        Ok(())
    }
    fn remove_config_setting(&mut self, name: &str) -> anyhow::Result<()> {
        self.removed.borrow_mut().push(name.to_string());
        Ok(())
    }
    fn add_property(&mut self, _name: &str, _value: PhpMixed) -> anyhow::Result<()> {
        unreachable!()
    }
    fn remove_property(&mut self, _name: &str) -> anyhow::Result<()> {
        unreachable!()
    }
    fn add_link(&mut self, _type: &str, _name: &str, _value: &str) -> anyhow::Result<()> {
        unreachable!()
    }
    fn remove_link(&mut self, _type: &str, _name: &str) -> anyhow::Result<()> {
        unreachable!()
    }
    fn get_name(&self) -> String {
        self.name.clone()
    }
}

fn build_github(
    io_mock: &Rc<RefCell<IOMock>>,
    config: Rc<RefCell<Config>>,
    http_downloader: Rc<RefCell<HttpDownloader>>,
) -> GitHub {
    let io: Rc<RefCell<dyn IOInterface>> = io_mock.clone();
    GitHub::new(io, config, None, Some(http_downloader)).unwrap()
}

// The PHP Config mock returns null for `get('github-expose-hostname')`, which is
// falsy and skips the `hostname` process call. A real Config defaults that key to
// true, so the stub seeds false to reproduce the mock's behaviour.
fn build_config() -> Rc<RefCell<Config>> {
    ConfigStubBuilder::new()
        .with("github-expose-hostname", PhpMixed::Bool(false))
        .build_shared()
}

#[test]
fn test_username_password_authentication_flow() {
    let (io_mock, _io_guard) = get_io_mock(io_interface::NORMAL).unwrap();
    io_mock
        .borrow_mut()
        .expects(
            vec![
                Expectation::text(MESSAGE),
                Expectation::ask("Token (hidden): ", PASSWORD),
            ],
            false,
        )
        .unwrap();

    let (http_downloader, _http_guard) = get_http_downloader_mock(
        vec![expect_full(
            format!("https://api.{}/", ORIGIN),
            None,
            200,
            "{}",
            vec![],
        )],
        true,
        HttpDownloaderMockHandler::default(),
    );

    let config = build_config();
    let (auth_source, _) = ConfigSourceMock::new("auth.json");
    let (conf_source, conf_removed) = ConfigSourceMock::new("config.json");
    config.borrow_mut().set_auth_config_source(auth_source);
    config.borrow_mut().set_config_source(conf_source);

    let mut github = build_github(&io_mock, config, http_downloader);

    assert!(
        github
            .authorize_oauth_interactively(ORIGIN, Some(MESSAGE))
            .unwrap()
    );
    assert_eq!(
        *conf_removed.borrow(),
        vec![format!("github-oauth.{}", ORIGIN)]
    );
}

#[test]
fn test_username_password_failure() {
    let (io_mock, _io_guard) = get_io_mock(io_interface::NORMAL).unwrap();
    io_mock
        .borrow_mut()
        .expects(vec![Expectation::ask("Token (hidden): ", PASSWORD)], false)
        .unwrap();

    let (http_downloader, _http_guard) = get_http_downloader_mock(
        vec![expect_full(
            format!("https://api.{}/", ORIGIN),
            None,
            401,
            "",
            vec![],
        )],
        true,
        HttpDownloaderMockHandler::default(),
    );

    let config = build_config();
    let (auth_source, _) = ConfigSourceMock::new("auth.json");
    config.borrow_mut().set_auth_config_source(auth_source);

    let mut github = build_github(&io_mock, config, http_downloader);

    assert!(!github.authorize_oauth_interactively(ORIGIN, None).unwrap());
}