tests: gpioget: fix potential crash

We're writing outside the values array. Fix the index.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: chip: fix potential segfault

The automatically cleaned up string is not initialized, but if
asprintf() failed, its contents would be undefined which could lead
to a segmentation fault.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: iter: fix potential segfault

All automatically cleaned up variables must be initialized. Otherwise
we risk calling free() on an uninitialized pointer if an assertion
fails before we assign it a value.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: gpioinfo: improve test descriptions

Explain more precisely what we're actually testing.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: gpioinfo: test incorrect input

Check if gpioinfo behaves correctly if the chip for which we want the
info dumped doesn't exist.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: gpioinfo: test cases for printing info about specific chips

Add test cases checking if gpioinfo correctly dumps info if we specify
only certain chips over command-line and omits the ones we don't
request.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: new assertions

Add two new string-related assertions for tests.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tools: capitalize 'GPIO' in error messages

Be consistent in all error messages in gpioget & gpioset.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: gpioset: test cases for invalid arguments

Add various test cases checking the behavior of gpioset when given
invalid arguments.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: gpioset: test the --sec argument

Make sure gpioset understands the --sec argument together
with --mode=time.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: gpioset: test the --active-low flag

Duplicate the basic exit mode test but use the --active-low flag and
verify that the values are inverted.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: gpioset: test the 'time' mode

Order gpioset to wait for 100 milliseconds before exiting, then sleep
for 200 milliseconds before checking if it exited correctly.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: gpioset: test case for the 'signal' mode

Run gpioset on a set of lines, give it a couple milliseconds to
execute, then send it SIGTERM and check that it exits correctly.

Repeat for SIGINT.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: improve sigprocmask()-related error messages

When sigprocmask() fails for how=SIG_BLOCK|SIG_UNBLOCK, say explicitly
we were unable to block/unblock SIGCHLD.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: unblock SIGCHLD after closing the signalfd

Restore the state from before running the subprocess.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: gpioset: check the 'exit' mode explicitly

Duplicate the previous 'exit' mode test but pass the mode argument
explicitly to gpioset.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: read siginfo after receiving SIGCHLD

If we don't actually read the signal info, the signals pile up after
every child process exits even if we close the sigfd.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: gpioset: test the 'wait' mode

Verify the behavior of gpioset in the 'wait' mode. Send a newline
to gpioset's standard input and check if it correctly exits.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: provide test_tool_stdin_write()

Implement a routine allowing the test code to write a formatted string
to the child process' standard input.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: gpioget: test the --active-low flag

Read all lines, change their values and re-read but this time pass
the --active-low flag to gpioget.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: add a simple test case for gpioset

Verify the 'exit' mode of gpioset.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: check reading specific lines with gpioget

Add a test case where we only read a couple GPIO line values at
specified offsets.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: new test case for gpioget

Verify that gpioget correctly bails out if the user requested to read
more GPIO lines than the number exposed by the chip.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: use calloc() where applicable

Introduce xcalloc() and use it whenever we're allocating an array
of elements.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: new test cases for gpioget

Verify the correct behavior of gpioget on invalid arguments.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: add a test case for gpioget

Add a simple test case for gpioget: read all lines at their initial
state, change the values of some of them and re-read.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: rename test_gpiotool_run()

Use the same prefix for all functions for tools testing.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: new test case for gpiodetect

Verify that we bail out if the user passes any non-option argument
to gpiodetect.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: verify the behavior of gpiofind in case of invalid arguments

Make sure we bail out with the correct error message when the user
doesn't give us exactly one GPIO line name.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

gpiofind: tweak the error message on invalid arguments

We print the same error message in case of too many or not enough
arguments. Make the message appropriate for both cases.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: fix a potential segfault

A string passed to test_free_str() must be allocated by malloc() or
NULL, so we need to initialize ptrn.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: fix a memory leak

We don't free the string allocated by asprintf() in a test case for
gpioinfo. Fix it.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: fix a test case for gpiofind

We must not hardcode the chip names. Use test_chip_name() instead.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: add a missing assertion

asprintf() can fail. Check its return value.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: improve the test names

Make the names of the gpiotools test cases more informative.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: new test case for gpioinfo

Check if we correctly report exported lines.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: tweak test output

Tweak the log message header a bit: instead of having a fixed width
of the contents between the brackets in the header, fix the length of
the whole header to 8 characters.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: add test cases for gpiofind

Verify the correct behavior of gpiofind in two cases: when it can find
a GPIO line by name and when the requested line doesn't exist.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: improve the version string test

Use the recently introduced regex matching function to verify that
the version string has a correct format.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: don't request gpio-mockup chips for the version string test

Change the line sizes list into an empty array.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: add a test case for gpioinfo

Add a simple test for gpioinfo.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: add regex handling

Add a routine allowing to check if a string contains a substring
matching against given regex pattern.

Also: add a corresponding assertion.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: request 0 chips for the error handling test case

We now support having no gpio-mockup chips for test cases. Update the
error handling test.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: allow having zero gpio-mockup chips for tests

We may have tests which don't require any gpio-mockup chips to be
present. When an empty array is given as the list of chip line counts,
the gpio-mockup module will not be loaded.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: add a simple test case for gpiodetect

Use the newly added API for subprocesses to test a simple use case
of the gpiodetect tool.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: add infrastructure for testing the tools

Implement new routines allowing to start an external process and
retrieve its output.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: new assertion

Add a new test macro which checks if given string contains a specific
substring using strstr().

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

README: explain what gpiod stands for

In case someone incorrectly thinks it stands for 'GPIO daemon'.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: tweak test output

Say PASS instead of OK when a test is passed.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: tweak the event worker

The event worker thread should only inject another line event if
pthread_cond_timedwait() returned -ETIMEDOUT. If it returned 0, then
the main thread called pthread_cond_broadcast() and either requested
the worker thread to terminate or to change the event configuration.

In both cases we should not inject an event.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: only cleanup the gpio-mockup module from the main process

In preparation for adding support for subprocesses: store the pid of
the main process and use it such that we don't try to unload the
mockup module twice leading to a splat from libkmod.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: convert named_lines into a general 'flags' field

We currently have the boolean 'named_lines' field in the test
description structure. Convert it to an integer in order to allow
passing multiple test switches in the future.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: rename a couple static functions

We use the 'test_' prefix to mark the testing framework API
definitions. Don't use it for static functions in gpiod-test.c.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: put the printf attribute in the header for _test_print_failed()

If the printf attribute is only present next to the function's
definition, the compiler only checks the calls in the same compilation
unit.

In order to verify all the calls, annotate the declaration of
_test_print_failed() in gpiod-test.h.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: make test_func private

The test callback prototype should not be used by the test code, so
prefix it with an underscore to indicate that.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: change the test API prefix

The gu_ prefix stood for gpiod unit, but it's no longer valid. These
definitions are not visible outside of the tests subdirectory, so
there's no need for a unique prefix. Just start all symbols with test_
or TEST_.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: use a default consumer name

We're using the same consumer name everywhere in the tests. Hide it
behind a define.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: rename gpiod-unit to gpiod-test

The testing framework will be reused for all kinds of tests. Also: the
tests we have are not really separated, but use external components so
calling them unit tests is wrong anyway.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: remove the unit subdirectory

Initially we planned to have different subdirectories for different
kinds of tests (unit, tools etc.) but since it was decided that we'll
reuse the already existing framework for all tests (in order to avoid
having to reimplement the same functionality) we can get rid of the
unit subdirectory.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

libgpiod: start v0.3 development cycle

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

libgpiod v0.2

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

NEWS: updates for v0.2

Add release notes for libgpiod v0.2.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

NEWS: wrap lines at 80 characters

Stick to the same standards everywhere in the project.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: add test cases for line events

Verify that low-level routines for line events work correctly.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: fix a dmesg error message from gpio-mockup

When checking if we can load gpio-mockup, we don't pass the
gpio_mockup_ranges argument to the module. This makes probe() fail
and causes an error message to be emitted.

Pass a correct argument to gpio-mockup so that a dummy GPIO chip gets
created and no errors are displayed.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: add a test case for misc line flags

Test the open drain, open source and kernel flags.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: move the test case execution into a separate function

For better readability move the code executing the test case into a
separate function - between the setup and teardown routines.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: add new assertion

GU_ASSERT_FALSE() checks if given statement evaluates to false.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: add a test case for gpiod_line_active_state()

Verify that the active state is changed correctly depending on the
parameters of the request.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: add a test case for gpiod_line_direction()

Verify that the direction is changed properly and that a correct value
is returned from gpiod_line_direction().

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

README: add some info on unit tests

Describe how to build and use the testing framework.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

libgpiod: add the NEWS file

It should have been there from the beginning but it was somehow
forgotten. Add it now - before the v0.2 release.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: add a test case for gpiod_simple_event_loop()

Test a very simple use case: wait for a single event of any type.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: extend the testing framework with support for event injecting

Add a routine allowing tests to specify a single event to be injected
at regular intervals.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

core: fix the return value of gpiod_simple_event_loop()

This routine should always return 0 when no errors were encountered.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: add a test case for gpiod_line_find_by_name()

Use the newly added support for named lines and add a test case
verifying that lines can be found by name.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: add support for named lines

If the named_lines field is true in the test description, pass an
additional module parameter to gpio-mockup to have the GPIO lines
named.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: require at least linux v4.11

This is the first linux kernel release that supports GPIO event
injecting over debugfs. Make it a hard requirement for running tests.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

build: readability tweak for the unit tests make message

Shift the text one character right for better readability.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: sort mockup chips by number, not by name

If we request more than 9 chips for a test case, we'll run into
a problem: 'gpiochip10' will come before 'gpiochip2' when sorting by
name.

Sort by chip number instead - it's stored as an unsigned integer and
the above situation will not occur.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: print an info message after building tests

We can't automatically run unit tests from 'make check' as the test
executable works together with the gpio-mockup kernel module. Without
any additional udev configuration /dev/gpiochipX files are only
accessible for superuser.

Print a message explaining what to do after the tests are built.

NOTE: the message says that linux kernel >=v4.11 is needed to run the
tests. This is not true currently, as we don't test events yet. Event
injecting over debugfs is a new feature of gpio-mockup and will be
available in the upcoming kernel release.

Once v4.11 is released and appropriate test cases implemented, we'll
make it a hard requirement for tests.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

build: use a more standard autogen.sh

This version of the autogen.sh script allows execution from a sub-
directory and will automatically run the configure script that it has
generated. This is useful for out-of-tree and cross builds.

Signed-off-by: Thierry Reding <treding@nvidia.com>
Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

build: store m4 files in an `m4' subdirectory

This is similar to the AUX directory that the autotools use to put
their files into, except that the `m4' directory will contain
autoconf macro files.

Signed-off-by: Thierry Reding <treding@nvidia.com>
Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

build: check for udev and kmod using pkg-config

Using AC_CHECK_LIB is dangerous because it modifies the global LIBS
variable that will be passed to each linker invocation. If care is not
taken, each binary will end up depending on libraries listed in this
variable.

A typical way to avoid this is to save and restore the LIBS variable
before and after the AC_CHECK_LIB function, respectively. That's quite
tedious, though, and often a better solution is to detect the presence
as well as compile and linker flags with pkg-config. This can be done
using the PKG_CHECK_MODULES autoconf macro.

Both udev and kmod ship pkg-config files, so use PKG_CHECK_MODULES for
them.

Signed-off-by: Thierry Reding <treding@nvidia.com>
Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: fix out-of-tree builds

When building out of tree, the config.h header file and the
libgpiod.la file are generated in the build rather than the
source directory.

While at it, link to libgpiod.la directly rather than via the
-L and -l linker options to enable extra libtool magic.

Signed-off-by: Thierry Reding <treding@nvidia.com>
Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: make gpiod-unit.h a source for gpiod-unit

Listing gpiod-unit.h as a source for the gpiod-unit binary ensures that
it is properly tracked as a dependency and that it will be included in
distribution tarballs.

Signed-off-by: Thierry Reding <treding@nvidia.com>
Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

gitignore: add libtools-common.la

Add the new convencience library created for gpio-tools to gitignore.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tools: build convenience library

Build a convenience library to avoid having to add the tools-common.c
source file for each of the tools.

This also has the side-effect of fixing 'make distcheck' because the
tools-common.h header file is now included in the source tarball.

Signed-off-by: Thierry Reding <treding@nvidia.com>
Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tools: fix out-of-tree builds

When building out of tree, the config.h header file and the libgpiod.la
file are generated in the build rather than the source directory.

While at it, link to libgpiod.la directly rather than via the -L and -l
linker options to enable extra libtool magic.

Signed-off-by: Thierry Reding <treding@nvidia.com>
Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

core: fix out-of-tree builds

When building out of tree, the config.h header file is generated in the
build directory rather than the source directory.

Signed-off-by: Thierry Reding <treding@nvidia.com>
Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: new test case for chip iterators

Verify that we can correctly break a loop in gpiod_foreach_chip().

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: add a test case for gpiod_line_consumer()

Verify that we get the correct consumer info after requesting a line.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: add a test case for busy lines

Run a scenario in which we try to request a line twice and verify that
the second attempt fails.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

core: fix checking for busy lines

If we have a bulk object containing only a single line passed to
verify_line_bulk(), we end up not checking if the line was previously
requested.

Fix it by starting the iteration at offset 0 instead of 1 and skipping
the line owner check for i == 0.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: remove gu_release_line()

There cannot be any memory leaks if we don't release a line as long
as we close the gpiochip handle. Remove all code releasing lines on
errors.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: fix a memory leak

We must free the error string from a failed test after displaying it.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: improve test descriptions

Use the test descriptions to tell the user exactly what
each test is validating.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: add a test case for a bad line request

Implement a test case in which we try to request lines from different
GPIO chips in a single bulk object.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: add a test case for gpiod_line_request_bulk_output()

Simple test case validating bulk output requests.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>

tests: add misc test cases

Add test cases for err handling and gpiod_version_string().

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>