10473118052

Committed 20 Aug 2024 02:03PM UTC coverage: 88.63% (-7.0%) from 95.679%

Build # 10473118052

Build Type

push

github

Committed by

web-flow

Commit Message

Merge pull request #1080 from oemof/revision/replace-constraint-tests

Replaces lp diff constraint tests by granular unit tests for functionality.

Reasoning:
- The LP files depend on Pyomo internals, thus they change when Pyomo changes things.
- They include tests for stuff from multiple parts of the code. For example, if I change the constraint formulation for the Bus, every constraint test needs to be rewritten, not only the one for the Bus.
- They are hard to understand (for many) and failed tests are hard to fix. The latter is particularly because of the undefined order of lines, so that just looking at a diff will not tell the difference: Constraints might be in a different order but still the same.

These unit tests still use Pyomo but the results are independent from the back-end. They are rather easy to understand (rather trivial test examples), and even internal constraint formulations can be changed without breaking the test, so it really tests for the specified functionally not the implementation.

Run Details

1177 of 1369 branches covered (85.98%)

Branch coverage included in aggregate %.

131 of 142 new or added lines in 10 files covered. (92.25%)

183 existing lines in 7 files now uncovered.

2471 of 2747 relevant lines covered (89.95%)

2.7 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

89.29

/src/oemof/solph/helpers.py

# -*- coding: utf-8 -*-

"""
This is a collection of helper functions which work on their own and can be
used by various classes.

SPDX-FileCopyrightText: Uwe Krien <krien@uni-bremen.de>
SPDX-FileCopyrightText: Caroline Möller
SPDX-FileCopyrightText: henhuy
SPDX-FileCopyrightText: gplssm
SPDX-FileCopyrightText: Stephan Günther
SPDX-FileCopyrightText: elisapap

SPDX-License-Identifier: MIT

"""

import os
from collections.abc import MutableMapping


def get_basic_path():
    """Returns the basic oemof path and creates it if necessary.
    The basic path is the '.oemof' folder in the $HOME directory.
    """
    basicpath = os.path.join(os.path.expanduser("~"), ".oemof")
    if not os.path.isdir(basicpath):
        os.mkdir(basicpath)
    return basicpath


def extend_basic_path(subfolder):
    """Returns a path based on the basic oemof path and creates it if
    necessary. The subfolder is the name of the path extension.
    """
    extended_path = os.path.join(get_basic_path(), subfolder)
    if not os.path.isdir(extended_path):
        os.mkdir(extended_path)
    return extended_path


def flatten(d, parent_key="", sep="_"):
    """
    Flatten dictionary by compressing keys.

    See: https://stackoverflow.com/questions/6027558/
         flatten-nested-python-dictionaries-compressing-keys

    d : (dictionary)
    parent_key : (do not use this, used internally for recursion)
    sep : separator for flattening keys

    Returns
    -------
    dict
    """
    items = []
    for k, v in d.items():
        new_key = parent_key + sep + str(k) if parent_key else str(k)
        if isinstance(v, MutableMapping):
            items.extend(flatten(v, new_key, sep=sep).items())
        else:
            items.append((new_key, v))
    return dict(items)

1	# -- coding: utf-8 --
2
3	"""
4	This is a collection of helper functions which work on their own and can be
5	used by various classes.
6
7	SPDX-FileCopyrightText: Uwe Krien <krien@uni-bremen.de>
8	SPDX-FileCopyrightText: Caroline Möller
9	SPDX-FileCopyrightText: henhuy
10	SPDX-FileCopyrightText: gplssm
11	SPDX-FileCopyrightText: Stephan Günther
12	SPDX-FileCopyrightText: elisapap
13
14	SPDX-License-Identifier: MIT
15
16	"""
17
18	import os	3✔
19	from collections.abc import MutableMapping	3✔
20
21
22	def get_basic_path():	3✔
23	"""Returns the basic oemof path and creates it if necessary.
24	The basic path is the '.oemof' folder in the $HOME directory.
25	"""
26	basicpath = os.path.join(os.path.expanduser("~"), ".oemof")	3✔
27	if not os.path.isdir(basicpath):	3!
UNCOV 28	os.mkdir(basicpath)	×
29	return basicpath	3✔
30
31
32	def extend_basic_path(subfolder):	3✔
33	"""Returns a path based on the basic oemof path and creates it if
34	necessary. The subfolder is the name of the path extension.
35	"""
36	extended_path = os.path.join(get_basic_path(), subfolder)	3✔
37	if not os.path.isdir(extended_path):	3!
38	os.mkdir(extended_path)	3✔
39	return extended_path	3✔
40
41
42	def flatten(d, parent_key="", sep="_"):	3✔
43	"""
44	Flatten dictionary by compressing keys.
45
46	See: https://stackoverflow.com/questions/6027558/
47	flatten-nested-python-dictionaries-compressing-keys
48
49	d : (dictionary)
50	parent_key : (do not use this, used internally for recursion)
51	sep : separator for flattening keys
52
53	Returns
54	-------
55	dict
56	"""
57	items = []	3✔
58	for k, v in d.items():	3✔
59	new_key = parent_key + sep + str(k) if parent_key else str(k)	3✔
60	if isinstance(v, MutableMapping):	3✔
61	items.extend(flatten(v, new_key, sep=sep).items())	3✔
62	else:
63	items.append((new_key, v))	3✔
64	return dict(items)	3✔

oemof / oemof-solph / 10473118052

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous