Refactored GPIO to be testable and gradle upgrade by ecsedigergo · Pull Request #116 · ftsrg/BME-MODES3

ecsedigergo · 2018-10-05T20:55:23Z

No description provided.

gradle deprecated features must be updated

1)set gpio to low 2)set gpio to high

benedekh

Why were the version upgrades of gradle, junit, mockito necessary?

benedekh

Why was this version upgrade necessary?

benedekh

Why do we commit code (dependency imports and source code) in comments?

zsoltmazlo · 2018-10-08T19:06:13Z

If I may interrupt, I think version upgrades are not that big a deal

benedekh

See the individual comments and recommendations.

benedekh · 2018-10-08T18:55:54Z


 	private TimerTask _inputListenerTask;

+	private static CommandWriter WRITER;


Why is this field static instead of instance level?

If the field will be instance-level, then please follow the lowercase naming convention also.

Because the GIPO Manager is a Singleton class and I want to set this writer from outside of the manager. So anyway it will have 1 instance.

But here the Gpio is neither a singleton nor a static-only class. So its methods and fields should be instance level.

That's another question, why is GpioManager a Singleton class with static-only methods? It should be either singleton or static-only. Mixing the two does not make too much sense.

benedekh · 2018-10-08T18:57:30Z

-			w.flush();
-		}
-		Logger.info(TAG, "Succeeded!");
+	public static void setWriter(CommandWriter writer) {


Please make this setter instance-level, instead of class-level.

Makes instance level setter any sense with Singleton GPIO manager?

Yes, because Gpio itself is neither Singleton, nor static-only. Here we are talking about Gpio.java and not GpioManager.java.

benedekh · 2018-10-08T18:58:37Z

+
+	private static CommandReader READER;
+
 	public Gpio(int pin, Direction direction) throws IOException, GpioNotConfiguratedException {


The initialization of READER and WRITER are missing here. You may end up having a NullPointerException.

If I got in this case (with static variables) a nullpointer, that is definitely a misconfiguration (you must set those before usage), so the exception must occur. Should I rather instantiate the variables with GPIOWriter/Reader when the GPIO manager is instantiated?

You should always make sure, that whenever the constructor is invoked, all the fields and variables that this constructor uses (invokes) must have been instantiated.

Having a separate setter of a field and making sure that that setter must have been invoked before anyone creates an instance of Gpio is very dangerous. (You rely on someone else to invoke those setters before any instance of this class is created.)

benedekh · 2018-10-08T19:06:17Z

+			infos.put(targetFile.substring(targetFile.lastIndexOf("/") + 1), value);
+		} catch (Exception e) {
+			// TODO: handle exception
+			throw e;


Please do proper error handling.

benedekh · 2018-10-08T19:07:02Z

 		pinout = ExpanderConfigInterpreter.loadPinoutConfig(factory)
 		GpioManager::loadGpioMappingFromFile(GPIO_JSON)
+		// TODO Check validity
+		GpioManager::setGpioWriter(new GpioWriter)


Why is only the GpioWriter instantiated here? What about GpioReader?

benedekh · 2018-10-08T19:08:19Z

+
+import hu.bme.mit.inf.modes3.components.gpiomanager.Gpio.Level;
+
+public class TestGpioReader implements CommandReader {


Why is a separate class created for test, instead of using Mockito and creating a Mock in the test case itself?
If you just return the same static value every time, then a Mock might be more suitable instead of a generally named TestGpioReader class.

True, it can be refactored.

benedekh · 2018-10-08T19:09:12Z

+import java.util.HashMap;
+import java.util.Map;
+
+public class TestGpioWriter implements CommandWriter {


What is the reason for having a 'dedicated' TestGpioWriter class instead of just mocking the corresponding field by mockito in the unit tests?

True, it can be refactored.

benedekh · 2018-10-08T19:10:56Z

+	}
+
+	@Override
+	public void executeCommand(String value, String targetFile) throws IOException {


Is this method invoked by different value and targetFile parameters in the unit tests? If so, then does it that unit test test this class itself or it is just a side-effect that this method will also be invoked and executed when you test another method (of another class) which invokes this class?

So, is there a reason why this 'test' class was implemented instead of just mocking it in the class/instance where it is invoked?

benedekh

See comments and recommendations.

benedekh · 2018-10-08T19:12:37Z

+		// assert
+		assertAll("properties", () -> assertEquals("in", tgw.getInfos().get("direction")),
+				() -> assertEquals(datas[0].port, Integer.parseInt(tgw.getInfos().get("export")))
+//				,() -> assertEquals("both", tgw.getInfos().get("edge"))


Why do we commit code in comments?

benedekh · 2018-10-08T19:12:42Z

+				() -> assertEquals("0", tgw.getInfos().get("value")));
+	}
+
+//	@Test


Why do we commit code in comments?

benedekh · 2018-10-08T19:14:40Z

A general question in the end: did you test the changes together with the modules (components) which use the GpioManager? Do these components work correctly after introducing the separate classes for CommandWriter and CommandReader in GpioManager?

ecsedigergo · 2018-10-09T17:36:54Z

General answer: First of all I did not have yet opportunity and the knowledge to test it, but its true, its necessary before the merge.

benedekh · 2018-10-11T19:58:46Z

If I may interrupt, I think version upgrades are not that big a deal

@zsoltmazlo There are two issues which might arise:

some internal code might broke within the modules if they heavily rely on some specific features of the dependencies.
every gradle project ought to use the same version of the dependency to avoid incompatibility / inconsistency issues. ('Everyone should be on the same page.' as the saying goes.)

benedekh · 2018-10-11T20:12:36Z

+	}
+
+	public static void setGpioWriter(CommandWriter writer) {
+		Gpio.setWriter(writer);


Btw, why do you have to invoke Gpio.setWriter here? It has nothing to do with the GpioManager class. Gpio.setWriter coud be invoked anywhere else in the code.

(The same applies for the setGpioReader function also.)

ecsedigergo · 2018-10-17T19:27:34Z

I wanted to use JUnit 5 and for that I had to upgrade the versions.

benedekh · 2018-10-17T21:01:34Z

@ecsedigergo Argument is accepted. If it does not cause any compilation (/ runtime) problems, then the version upgrade is good to go.

ecsedigergo added 5 commits September 4, 2018 00:03

upgrade to gradle-4.10 and junit-5

a3a4f91

gradle deprecated features must be updated

xtend upgrade

b600c7e

Fixed trainmovementestimator test and moved to photon

74d5923

GPIO tests implemented#1

61d887c

1)set gpio to low 2)set gpio to high

Refactored GPIO tests

5f0a827

benedekh requested review from benedekh and hegyibalint October 6, 2018 20:36

benedekh reviewed Oct 8, 2018

View reviewed changes

benedekh requested changes Oct 8, 2018

View reviewed changes

benedekh reviewed Oct 11, 2018

View reviewed changes

ecsedigergo added 3 commits November 27, 2018 22:28

Implemented GPIOManager component tests

078b669

TEC call to GPIOManager fixed

e5a9b23

covered GPIO exception branches also

27f23f5

hegyibalint removed their request for review March 19, 2025 09:02


		private TimerTask _inputListenerTask;

		private static CommandWriter WRITER;


		private static CommandReader READER;

		public Gpio(int pin, Direction direction) throws IOException, GpioNotConfiguratedException {


		import hu.bme.mit.inf.modes3.components.gpiomanager.Gpio.Level;

		public class TestGpioReader implements CommandReader {

Uh oh!

Conversation

ecsedigergo commented Oct 5, 2018

Uh oh!

benedekh left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

benedekh left a comment

Choose a reason for hiding this comment

Uh oh!

benedekh left a comment

Choose a reason for hiding this comment

Uh oh!

zsoltmazlo commented Oct 8, 2018

Uh oh!

benedekh left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ecsedigergo Oct 9, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

benedekh left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

benedekh commented Oct 8, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ecsedigergo commented Oct 9, 2018

Uh oh!

benedekh commented Oct 11, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ecsedigergo commented Oct 17, 2018

Uh oh!

benedekh commented Oct 17, 2018

Uh oh!

Reviewers

benedekh left a comment •

edited

Loading

ecsedigergo Oct 9, 2018 •

edited

Loading

benedekh commented Oct 8, 2018 •

edited

Loading