Debian Codegraph @

raster/r.mask.status/tests/r_mask_status_test.py

raw
1 """Tests of r.mask.status"""
2
3 import pytest
4
5 try:
6 import yaml
7 except ImportError:
8 yaml = None
9
10 import grass.script as gs
11
12
13 DEFAULT_MASK_NAME = "MASK"
14
15
16 def test_json_no_mask(session_no_data):
17 """Check JSON format for no mask"""
18 session = session_no_data
19 data = gs.parse_command("r.mask.status", format="json", env=session.env)
20 assert "present" in data
21 assert "name" in data
22 assert data["name"], "Mask name needs to be always set"
23 assert data["name"] == f"{DEFAULT_MASK_NAME}@PERMANENT"
24 assert "is_reclass_of" in data
25 assert data["present"] is False
26 assert not data["is_reclass_of"]
27
28
29 def test_json_with_r_mask(session_with_data):
30 """Check JSON format for the r.mask case"""
31 session = session_with_data
32 gs.run_command("r.mask", raster="a", env=session.env)
33 data = gs.parse_command("r.mask.status", format="json", env=session.env)
34 assert data["present"] is True
35 assert data["name"] == f"{DEFAULT_MASK_NAME}@PERMANENT"
36 assert data["is_reclass_of"] == "a@PERMANENT"
37 # Now remove the mask.
38 gs.run_command("r.mask", flags="r", env=session.env)
39 data = gs.parse_command("r.mask.status", format="json", env=session.env)
40 assert data["present"] is False
41 assert data["name"] == f"{DEFAULT_MASK_NAME}@PERMANENT"
42 assert not data["is_reclass_of"]
43
44
45 def test_json_with_g_copy(session_with_data):
46 """Check JSON format for the low-level g.copy case"""
47 session = session_with_data
48 gs.run_command("g.copy", raster=["a", DEFAULT_MASK_NAME], env=session.env)
49 data = gs.parse_command("r.mask.status", format="json", env=session.env)
50 assert data["present"] is True
51 assert data["name"] == f"{DEFAULT_MASK_NAME}@PERMANENT"
52 assert not data["is_reclass_of"]
53 # Now remove the mask.
54 gs.run_command(
55 "g.remove", type="raster", name=DEFAULT_MASK_NAME, flags="f", env=session.env
56 )
57 data = gs.parse_command("r.mask.status", format="json", env=session.env)
58 assert data["present"] is False
59 assert data["name"] == f"{DEFAULT_MASK_NAME}@PERMANENT"
60 assert not data["is_reclass_of"]
61
62
63 def test_shell(session_with_data):
64 """Check shell format for the r.mask case"""
65 session = session_with_data
66 gs.run_command("r.mask", raster="a", env=session.env)
67 data = gs.parse_command("r.mask.status", format="shell", env=session.env)
68 assert int(data["present"])
69 assert data["name"] == f"{DEFAULT_MASK_NAME}@PERMANENT"
70 assert data["is_reclass_of"] == "a@PERMANENT"
71 # Now remove the mask.
72 gs.run_command("r.mask", flags="r", env=session.env)
73 data = gs.parse_command("r.mask.status", format="shell", env=session.env)
74 assert not int(data["present"])
75 assert data["name"] == f"{DEFAULT_MASK_NAME}@PERMANENT"
76 assert not data["is_reclass_of"]
77
78
79 @pytest.mark.skipif(yaml is None, reason="PyYAML package not available")
80 def test_yaml(session_with_data):
81 """Check YAML format for the r.mask case"""
82 session = session_with_data
83 gs.run_command("r.mask", raster="a", env=session.env)
84 text = gs.read_command("r.mask.status", format="yaml", env=session.env)
85 data = yaml.safe_load(text)
86 assert data["present"] is True
87 assert data["name"] == f"{DEFAULT_MASK_NAME}@PERMANENT"
88 assert data["is_reclass_of"] == "a@PERMANENT"
89 # Now remove the mask.
90 gs.run_command("r.mask", flags="r", env=session.env)
91 text = gs.read_command("r.mask.status", format="yaml", env=session.env)
92 data = yaml.safe_load(text)
93 assert data["present"] is False
94 assert data["name"] == f"{DEFAULT_MASK_NAME}@PERMANENT"
95 assert not data["is_reclass_of"]
96
97
98 def test_plain(session_with_data):
99 """Check plain text format for the r.mask case"""
100 session = session_with_data
101 gs.run_command("r.mask", raster="a", env=session.env)
102 text = gs.read_command("r.mask.status", format="plain", env=session.env)
103 assert text
104 assert f"{DEFAULT_MASK_NAME}@PERMANENT" in text
105 assert "a@PERMANENT" in text
106 # Now remove the mask.
107 gs.run_command("r.mask", flags="r", env=session.env)
108 text = gs.read_command("r.mask.status", format="plain", env=session.env)
109 assert text
110 assert f"{DEFAULT_MASK_NAME}@PERMANENT" in text
111 assert "a@PERMANENT" not in text
112
113
114 def test_without_parameters(session_no_data):
115 """Check output is generated with no parameters"""
116 session = session_no_data
117 text = gs.read_command("r.mask.status", env=session.env)
118 assert text
119
120
121 def test_behavior_mimicking_test_program(session_with_data):
122 """Check test program like behavior for the r.mask case"""
123 session = session_with_data
124 gs.run_command("r.mask", raster="a", env=session.env)
125 returncode = gs.run_command(
126 "r.mask.status", flags="t", env=session.env, errors="status"
127 )
128 assert returncode == 0
129 # Now remove the mask.
130 gs.run_command("r.mask", flags="r", env=session.env)
131 returncode = gs.run_command(
132 "r.mask.status", flags="t", env=session.env, errors="status"
133 )
134 assert returncode == 1