ink-analyzer 0.11.2

A library for semantic analysis of ink! smart contracts.
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

//! integration tests for ink! analyzer hover content.

mod utils;

use crate::utils::ink_version_from_path;
use ink_analyzer::{Analysis, TextRange, TextSize};
use test_utils::{TestCaseParams, TestCaseResults};

// The high-level methodology for hover content test cases is:
// - Read the source code of an ink! entity file in the `test-fixtures` directory
//   (e.g. https://github.com/ink-analyzer/ink-analyzer/blob/master/test-fixtures/v4/erc20.rs).
// - (Optionally) Make some modifications to the source code at a specific offset/text range to create a specific test case.
// - Compute hover content for the modified source code and a specific text range.
// - Verify that the actual results match the expected results.
// See inline comments for more details.
#[test]
fn hover_works() {
    // Iterates over all test case groups (see [`test_utils::fixtures::hover_fixtures`] doc and inline comments).
    for test_group in test_utils::fixtures::hover_fixtures() {
        // Gets the original source code.
        let original_code = test_utils::read_source_code(test_group.source);

        // Iterates over all test cases.
        for test_case in test_group.test_cases {
            // Creates a copy of test code for this test case.
            let mut test_code = original_code.clone();

            // Applies test case modifications (if any).
            if let Some(modifications) = test_case.modifications {
                test_utils::apply_test_modifications(&mut test_code, &modifications);
            }

            // Sets the focus range.
            let (range_start_pat, range_end_pat) = match test_case.params.unwrap() {
                TestCaseParams::Hover(it) => Some((it.start_pat, it.end_pat)),
                _ => None,
            }
            .unwrap();
            let range = TextRange::new(
                TextSize::from(
                    test_utils::parse_offset_at(&test_code, range_start_pat).unwrap() as u32,
                ),
                TextSize::from(
                    test_utils::parse_offset_at(&test_code, range_end_pat).unwrap() as u32,
                ),
            );

            // Get hover content.
            let version = ink_version_from_path(test_group.source);
            let results = Analysis::new(&test_code, version).hover(range);

            // Verifies hover content.
            let expected_results = match test_case.results {
                TestCaseResults::Hover(it) => Some(it),
                _ => None,
            }
            .unwrap();
            assert_eq!(
                results.is_some(),
                expected_results.is_some(),
                "source: {}",
                test_group.source
            );
            if results.is_some() {
                assert!(
                    results
                        .as_ref()
                        .unwrap()
                        .content
                        .contains(expected_results.as_ref().unwrap().text),
                    "source: {}",
                    test_group.source
                );
            }
            assert_eq!(
                results.as_ref().map(|hover| hover.range),
                expected_results.map(|result| TextRange::new(
                    TextSize::from(
                        test_utils::parse_offset_at(&test_code, result.start_pat).unwrap() as u32
                    ),
                    TextSize::from(
                        test_utils::parse_offset_at(&test_code, result.end_pat).unwrap() as u32
                    ),
                )),
                "source: {}",
                test_group.source
            );
        }
    }
}