Skip to content

Commit 981d715

Browse files
lisajulialisajulia
authored
Merge pull request #11 from hakonhagland/gha_test
Added a test case
2 parents e07f860 + 0659014 commit 981d715

14 files changed

+779
-7
lines changed

‎.github/workflows/python_scripts.yml

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: Test Python scripts
2+
3+
# NOTE: Added "push" here such that PR authors can test the actions in their forked repository
4+
# before submitting a PR.
5+
# NOTE: It is not possible to avoid the duplication of the paths in the "push" and
6+
# "pull_request" sections. This is a known limitation of the GitHub Actions syntax.
7+
on:
8+
push:
9+
paths:
10+
- 'python/sphinx_docs/**'
11+
- '.github/workflows/python_scripts.yml'
12+
pull_request:
13+
paths:
14+
- 'python/sphinx_docs/**'
15+
- '.github/workflows/python_scripts.yml'
16+
17+
permissions:
18+
contents: read
19+
20+
jobs:
21+
build:
22+
runs-on: ${{ matrix.os }}
23+
strategy:
24+
matrix:
25+
os: [ubuntu-latest, macos-latest, windows-latest]
26+
python-version: ["3.11", "3.12"]
27+
steps:
28+
- name: checkout source code
29+
uses: actions/checkout@v3
30+
- name: Set up Python ${{ matrix.python-version }}
31+
uses: actions/setup-python@v4
32+
with:
33+
python-version: ${{ matrix.python-version }}
34+
- name: Install poetry
35+
uses: abatilo/actions-poetry@v2
36+
- name: Install dependencies
37+
run: |
38+
cd python/sphinx_docs
39+
poetry install
40+
- name: Run tests
41+
run: |
42+
cd python/sphinx_docs
43+
poetry run pytest tests

‎.gitignore

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Files necessary to build the documentation locally, but these are tracked by other github repositories
2-
dune.module
2+
/dune.module
33
python/docstrings_common.json
44
python/docstrings_simulators.json
55

@@ -12,3 +12,6 @@ python/sphinx_docs/docs/_build*
1212
# Editor autosave files
1313
*~
1414
*.swp
15+
16+
# Python coverage files
17+
python/sphinx_docs/.coverage

‎python/sphinx_docs/Makefile

+7
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,10 @@ docs:
1010

1111
view-docs:
1212
@xdg-open "file://$(GIT_ROOT)/python/sphinx_docs/docs/_build/$(CURRENT_BRANCH)/index.html"
13+
14+
test:
15+
pytest tests/
16+
17+
coverage:
18+
coverage run -m pytest tests
19+
coverage report -m

‎python/sphinx_docs/poetry.lock

+201-6
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎python/sphinx_docs/pyproject.toml

+6
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,12 @@ sphinx-versioned-docs = "^1.3.1"
2020
opmdoc-download-files = "opm_python_docs.download_files:main"
2121
opmdoc-view-doc = "opm_python_docs.view_docs:main"
2222

23+
[tool.poetry.group.dev.dependencies]
24+
pytest = "^8.3.4"
25+
pytest-mock = "^3.14.0"
26+
gitpython = "^3.1.44"
27+
coverage = "^7.6.10"
28+
2329
[build-system]
2430
requires = ["poetry-core"]
2531
build-backend = "poetry.core.masonry.api"

‎python/sphinx_docs/src/opm_python_docs/view_docs.py

+1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
#! /usr/bin/env python3
22

33
import logging
4+
import os
45

56
import click
67

‎python/sphinx_docs/tests/__init__.py

Whitespace-only changes.

‎python/sphinx_docs/tests/common.py

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
from typing import Protocol
2+
from pathlib import Path
3+
4+
class CreateGitDirFunc(Protocol): # pragma: no cover
5+
def __call__(self, add_config_ini: bool) -> Path:
6+
pass
7+

‎python/sphinx_docs/tests/conftest.py

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
import shutil
2+
from pathlib import Path
3+
4+
import git
5+
import pytest
6+
from pytest_mock.plugin import MockerFixture
7+
from .common import CreateGitDirFunc
8+
9+
@pytest.fixture(scope="session")
10+
def test_file_path() -> Path:
11+
return Path(__file__).parent / "files"
12+
13+
@pytest.fixture()
14+
def create_git_repo(
15+
tmp_path: Path,
16+
test_file_path: Path,
17+
mocker: MockerFixture,
18+
) -> CreateGitDirFunc:
19+
def _create_git_repo() -> Path:
20+
# Create a temporary directory
21+
git_root = tmp_path / "opm-python-documentation"
22+
git_root.mkdir()
23+
repo = git.Repo.init(str(git_root))
24+
repo.git.checkout("-b", "master")
25+
index = repo.index
26+
# Copy the test files to the temporary directory
27+
test_files = [
28+
{"docstrings_common.json": "python"},
29+
{"docstrings_simulators.json": "python"},
30+
{"dune.module": ""},
31+
{"index.html": "python/sphinx_docs/docs/_build/master"},
32+
]
33+
for file_info in test_files:
34+
# Copy the file to the destination directory, creating any necessary parent directories
35+
for filename, sub_dir in file_info.items():
36+
dest_dir = git_root / sub_dir
37+
dest_dir.mkdir(parents=True, exist_ok=True)
38+
dest_file = dest_dir / filename
39+
shutil.copy(test_file_path / filename, dest_file)
40+
index.add([str(dest_file)])
41+
author = git.Actor("opmuser", "[email protected]")
42+
committer = author
43+
index.commit("Initial commit", author=author, committer=committer)
44+
return git_root
45+
return _create_git_repo

‎python/sphinx_docs/tests/files/docstrings_common.json

+172
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,172 @@
1+
{
2+
"SummaryStateClass":{
3+
"type": "class",
4+
"signature": "opm.io.sim.SummaryState",
5+
"doc": "The SummaryState class - this is where the current summary results of the simulator are stored.\nThe SummaryState class has methods to get hold of well, group and general variables."
6+
},
7+
"SummaryState_update_well_var": {
8+
"signature": "opm.io.sim.SummaryState.update_well_var(well_name: str, variable_name: str, new_value: double) -> None",
9+
"doc": "Updates the variable of a well.\n\n:param well_name: The name of the well.\n:type well_name: str\n:param variable_name: The name of the variable to update.\n:type variable_name: str\n:param new_value: The new value of the variable.\n:type new_value: double"
10+
},
11+
"SummaryState_update_group_var": {
12+
"signature": "opm.io.sim.SummaryState.update_group_var(group_name: str, variable_name: str, new_value: double) -> None",
13+
"doc": "Updates the variable of a group.\n\n:param group_name: The name of the group.\n:type group_name: str\n:param variable_name: The name of the variable to update.\n:type variable_name: str\n:param new_value: The new value of the variable.\n:type new_value: double"
14+
},
15+
"SummaryState_well_var": {
16+
"signature": "opm.io.sim.SummaryState.well_var(well_name: str, variable_name: str) -> double",
17+
"doc": "Gets the value of a variable for a well.\n\n:param well_name: The name of the well.\n:type well_name: str\n:param variable_name: The name of the variable to retrieve.\n:type variable_name: str\n\n:return: The value of the specified variable for the well. \n:type return: double"
18+
},
19+
"SummaryState_group_var": {
20+
"signature": "opm.io.sim.SummaryState.group_var(group_name: str, variable_name: str) -> double",
21+
"doc": "Gets the value of a variable for a group.\n\n:param group_name: The name of the group.\n:type group_name: str\n:param variable_name: The name of the variable to retrieve.\n:type variable_name: str\n\n:return: The value of the specified variable for the group. \n:type return: double"
22+
},
23+
"SummaryState_elapsed": {
24+
"signature": "opm.io.sim.SummaryState.elapsed() -> double",
25+
"doc": "Returns the elapsed time in seconds of the current simulation.\n\n:return: The elapsed time in seconds. \n:type return: double"
26+
},
27+
"SummaryState_groups": {
28+
"signature": "opm.io.sim.SummaryState.groups -> list",
29+
"doc": "Returns a list of strings containing all group names.\n\n:return: A list of strings representing all group names. \n:type return: list"
30+
},
31+
"SummaryState_wells": {
32+
"signature": "opm.io.sim.SummaryState.wells -> list",
33+
"doc": "Returns a list of strings containing all well names.\n\n:return: A list of strings representing all well names. \n:type return: list"
34+
},
35+
"SummaryState_has_well_var": {
36+
"signature": "opm.io.sim.SummaryState.has_well_var(well_name: str, variable_name: str) -> bool",
37+
"doc": "Checks if a well variable exists.\n\n:param well_name: The name of the well.\n:type well_name: str\n:param variable_name: The name of the variable to check.\n:type variable_name: str\n\n:return: True if the variable exists for the well, False otherwise. \n:type return: bool"
38+
},
39+
"SummaryState_has_group_var": {
40+
"signature": "opm.io.sim.SummaryState.has_group_var(group_name: str, variable_name: str) -> bool",
41+
"doc": "Checks if a group variable exists.\n\n:param group_name: The name of the group.\n:type group_name: str\n:param variable_name: The name of the variable to check.\n:type variable_name: str\n\n:return: True if the variable exists for the group, False otherwise. \n:type return: bool"
42+
},
43+
"EclipseStateClass": {
44+
"type": "class",
45+
"signature": "opm.io.ecl_state.EclipseState",
46+
"doc": "The EclipseState class - this is a representation of all static properties in the model,ranging from porosity to relperm tables.\nThe content of the EclipseState is immutable and may not be changed at runtime."
47+
},
48+
"EclipseState_input_nnc": {
49+
"signature": "opm.io.ecl_state.EclipseState.input_nnc() -> list",
50+
"doc": "Returns a list of non-neighboring connections.\n\nOne non-neighboring connection is a tuple containing the following elements:\n- index1 (int): Index of the first cell.\n- index2 (int): Index of the second cell.\n- transmissibility (double): Transmissibility between the two cells.\n\n:return: A list of non-neighboring connections. \n:type return: list"
51+
},
52+
"EclipseState_faultNames": {
53+
"signature": "opm.io.ecl_state.EclipseState.faultNames() -> list",
54+
"doc": "Returns a list of fault names.\n\n:return: A list containing the names of faults. \n:type return: list"
55+
},
56+
"EclipseState_faultFaces": {
57+
"signature": "opm.io.ecl_state.EclipseState.faultFaces(fault_name: str) -> list",
58+
"doc": "Returns a list of faces of a fault with the given name.\n\n:param fault_name: The name of the fault.\n:type fault_name: str\n\n:return: A list containing the faces of the specified fault. \n:type return: list"
59+
},
60+
"EclipseState_jfunc": {
61+
"signature": "opm.io.ecl_state.EclipseState.jfunc() -> dict",
62+
"doc": "Function returning a dictionary with the following entries: ['FLAG', 'DIRECTION', 'ALPHA_FACTOR', 'BETA_FACTOR', 'OIL_WATER', 'GAS_OIL']\n\n:return: A dictionary containing the specified entries. \n:type return: dict"
63+
},
64+
"EclipseState_simulation": {
65+
"signature": "opm.io.ecl_state.EclipseState.simulation() -> SimulationConfiguration",
66+
"doc": "Returns the simulation configuration.\n\n:return: The simulation configuration. \n:type return: SimulationConfiguration"
67+
},
68+
"ScheduleClass": {
69+
"type": "class",
70+
"signature": "opm.io.schedule.Schedule",
71+
"doc": "The Schedule class - this is a representation of all the content from the SCHEDULE section, notably all well and group information and the timestepping."
72+
},
73+
"Schedule_getitem": {
74+
"signature": "opm.io.schedule.Schedule.__getitem__(report_step: int) -> ScheduleState",
75+
"doc": "Returns the ScheduleState at the given report step.\n\n:param report_step: The report step.\n:type report_step: int\n\n:return: The ScheduleState at the given report step.\n:type return: ScheduleState"
76+
},
77+
"Schedule_shut_well_well_name_step": {
78+
"signature": "opm.io.schedule.Schedule.shut_well(well_name: str, step: int) -> None",
79+
"doc": "Shuts down a well at a given report step.\n\n:param well_name: The name of the well to shut down.\n:type well_name: str\n:param step: The report step at which to shut down the well.\n:type step: int"
80+
},
81+
"Schedule_shut_well_well_name": {
82+
"signature": "opm.io.schedule.Schedule.shut_well(well_name: str) -> None",
83+
"doc": "Shuts down a well at the current report step.\n\n:param well_name: The name of the well to shut down.\n:type well_name: str"
84+
},
85+
"Schedule_open_well_well_name_step": {
86+
"signature": "opm.io.schedule.Schedule.open_well(well_name: str, step: int) -> None",
87+
"doc": "Opens a well at a given report step.\n\n:param well_name: The name of the well to open.\n:type well_name: str\n:param step: The report step at which to open the well.\n:type step: int\n:raises ValueError: If the report step is in the past or exceeds the duration of the simulation."
88+
},
89+
"Schedule_open_well_well_name": {
90+
"signature": "opm.io.schedule.Schedule.open_well(well_name: str) -> None",
91+
"doc": "Opens a well at the current report step.\n\n:param well_name: The name of the well to open.\n:type well_name: str"
92+
},
93+
"Schedule_stop_well_well_name_step":{
94+
"signature": "opm.io.schedule.Schedule.stop_well(well_name: str, step: int) -> None",
95+
"doc": "Stops a well at a given report step.\n\n:param well_name: The name of the well to stop.\n:type well_name: str\n:param step: The report step at which to stop the well.\n:type step: int\n:raises ValueError: If the report step is in the past or exceeds the duration of the simulation."
96+
},
97+
"Schedule_stop_well_well_name": {
98+
"signature": "opm.io.schedule.Schedule.stop_well(well_name: str) -> None",
99+
"doc": "Stops a well at the current report step.\n\n:param well_name: The name of the well to stop.\n:type well_name: str"
100+
},
101+
"Schedule_get_injection_properties": {
102+
"signature": "opm.io.schedule.Schedule.get_injection_properties(well_name: str, report_step: int) -> dict",
103+
"doc": "Gets injection properties for a well at a specific report step.\n\n:param well_name: The name of the well.\n:type well_name: str\n:param report_step: The report step to retrieve properties for.\n:type report_step: int\n\n:return: A dict containing the properties surf_inj_rate, resv_inj_rate, bhp_target, thp_target. \n:type return: dict"
104+
},
105+
"Schedule_get_production_properties": {
106+
"signature": "opm.io.schedule.Schedule.get_production_properties(well_name: str, report_step: int) -> dict",
107+
"doc": "Gets production properties for a well at a specific report step.\n\n:param well_name: The name of the well.\n:type well_name: str\n:param report_step: The report step to retrieve properties for.\n:type report_step: int\n\n:return: A dict containing the properties oil_rate, gas_rate, water_rate, liquid_rate, resv_rate, bhp_target, thp_target, alq_value. \n:type return: dict"
108+
},
109+
"Schedule_groups": {
110+
"signature": "opm.io.schedule.Schedule._groups(report_step: int) -> list",
111+
"doc": "Gets a list of all groups at a specified report step.\n\n:param report_step: The report step to retrieve groups for.\n:type report_step: int\n\n:return: A list containing all groups at the specified report step. \n:type return: list"
112+
},
113+
"Schedule_get_well": {
114+
"signature": "opm.io.schedule.Schedule.get_well(well_name: str, report_step: int) -> Well",
115+
"doc": "Retrieves a well at a given report step.\n\n:param well_name: The name of the well.\n:type well_name: str\n:param report_step: The report step.\n:type report_step: int\n\n:return: Well object at the given report step. \n:type return: well"
116+
},
117+
"Schedule_get_wells": {
118+
"signature": "opm.io.schedule.Schedule.get_wells(well_name_pattern: str) -> list",
119+
"doc": "Gets the names of wells matching a specified pattern.\n\n:param well_name_pattern: The pattern for well names, where '*' acts as a wildcard.\n:type well_name_pattern: str\n\n:return: A list containing the names of wells that match the specified pattern. \n:type return: list"
120+
},
121+
"GroupClass": {
122+
"signature": "Group",
123+
"type": "class",
124+
"doc": "The Group class."
125+
},
126+
"Group_name": {
127+
"signature": "Group.name",
128+
"doc": "Returns the name of this group.\n\n:return: The name of this group.\n:type return: str"
129+
},
130+
"Group_num_wells": {
131+
"signature": "Group.num_wells",
132+
"doc": "Returns the number of wells in this group.\n\n:return: The number of wells in this group.\n:type return: int"
133+
},
134+
"Group_well_names": {
135+
"signature": "Group.well_names",
136+
"doc": "Returns a list of all well names in this group.\n\n:return: A list of all well names in this group.\n:type return: list"
137+
},
138+
"ScheduleStateClass": {
139+
"signature": "ScheduleState",
140+
"type": "class",
141+
"doc": "The ScheduleState class."
142+
},
143+
"ScheduleState_nupcol": {
144+
"signature": "ScheduleState.nupcol",
145+
"doc": "The NUPCOL value at this Schedule State. This is a positive integer that defines the maximum number of Newton iterations used to update well targets within a time step."
146+
},
147+
"ScheduleState_get_group": {
148+
"signature": "ScheduleState.get_group(group_name: str) -> Group",
149+
"doc": "Gets the group with the specified name from the schedule state.\n\n:param group_name: The name of the group to retrieve from the schedule state.\n:type group_name: str\n\n:return: The group with the specified name from the schedule state. \n:type return: Group"
150+
},
151+
"WellClass": {
152+
"type": "class",
153+
"signature": "Well",
154+
"doc": "The Well class."
155+
},
156+
"Well_pos": {
157+
"signature": "Well.pos() -> tuple",
158+
"doc": "Retrieves the position of the well.\n\n:return: A tuple containing the (i, j) coordinates and the reference depth of the well. \n:type return: tuple"
159+
},
160+
"Well_isdefined": {
161+
"signature": "Well.isdefined(report_step: int) -> bool",
162+
"doc": "Checks if the well is defined at a specific report step.\n\n:param report_step: The report step to check for the well's definition.\n:type report_step: int\n\n:return: True if the well is defined at the specified report step, False otherwise. \n:type return: bool"
163+
},
164+
"Well_available_gctrl": {
165+
"signature": "Well.available_gctrl() -> bool",
166+
"doc": "Checks if the well is available for group control.\n\n:return: True if the well is available for group control, False otherwise. \n:type return: bool"
167+
},
168+
"Well_connections": {
169+
"signature": "Well.connections() -> list",
170+
"doc": "Gets a list of all connections associated with the well.\n\n:return: A list containing all connections of the well. \n:type return: list"
171+
}
172+
}

0 commit comments

Comments
 (0)