Extend ubuntu autotools github CI workflow to test make install/unins…

…tall targets (#958)

Run `make install` then build and run a simple initialize/terminate program. Then run `make uninstall` and check that building the test program again fails. wip for #957

.github/workflows/autotools.yml

@@ -6,6 +6,21 @@ on:
   pull_request:
     branches: [ master ]
 
+env:
+  # GitHub CI Actions-specific environment variables:
+
+  # Location for user-local `make install`
+  PORTAUDIO_INSTALL_DIR: /home/runner/.local
+
+  # Environment variables for compiling and running the test program.
+  # Usually none of this is needed as `make install` would install to system locations
+  # where include and library search paths are already set up to just work.
+  # gcc environment variables. see https://gcc.gnu.org/onlinedocs/gcc/Environment-Variables.html
+  C_INCLUDE_PATH: /home/runner/.local/include
+  LIBRARY_PATH: /home/runner/.local/lib
+  # runtime dynamically linked library search path. see https://stackoverflow.com/questions/480764
+  LD_LIBRARY_PATH: /home/runner/.local/lib
+
 jobs:
   build-autotools:
 
@@ -14,7 +29,24 @@ jobs:
 
     steps:
     - uses: actions/checkout@v2
+    # test configure and build
     - name: configure
-      run: ./configure
+      run: ./configure --prefix=$PORTAUDIO_INSTALL_DIR
     - name: make
       run: make
+    # test make install
+    - name: install
+      run: make install
+    - name: list install dirs (post-install)
+      run: ls $PORTAUDIO_INSTALL_DIR $PORTAUDIO_INSTALL_DIR/include $PORTAUDIO_INSTALL_DIR/lib
+    - name: build patest_init.c (test just calls Pa_Initialize();Pa_Terminate();)
+      run: gcc -o patest_init ./test/patest_init.c -lportaudio
+    - name: run patest_init
+      run: ./patest_init
+      # test make uninstall
+    - name: uninstall
+      run: make uninstall
+    - name: list install dirs (post-uninstall)
+      run: ls $PORTAUDIO_INSTALL_DIR $PORTAUDIO_INSTALL_DIR/include $PORTAUDIO_INSTALL_DIR/lib
+    - name: build patest_init.c to check uninstall (expect failure)
+      run: if gcc -o patest_init ./test/patest_init.c -lportaudio; then exit 1; else exit 0; fi

test/patest_init.c

@@ -0,0 +1,76 @@
+/** @file patest_init.c
+    @ingroup test_src
+    @brief Initialize and terminate PortAudio
+    @author Ross Bencina
+*/
+/*
+ * $Id$
+ *
+ * This program uses the PortAudio Portable Audio Library.
+ * For more information see: http://www.portaudio.com
+ * Copyright (c) 1999-2024 Ross Bencina and Phil Burk
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining
+ * a copy of this software and associated documentation files
+ * (the "Software"), to deal in the Software without restriction,
+ * including without limitation the rights to use, copy, modify, merge,
+ * publish, distribute, sublicense, and/or sell copies of the Software,
+ * and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be
+ * included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+ * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR
+ * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
+ * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+ * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+/*
+ * The text above constitutes the entire PortAudio license; however,
+ * the PortAudio community also makes the following non-binding requests:
+ *
+ * Any person wishing to distribute modifications to the Software is
+ * requested to send the modifications to the original developer so that
+ * they can be incorporated into the canonical version. It is also
+ * requested that these non-binding requests be included along with the
+ * license above.
+ */
+
+#include <stdio.h>
+
+#include "portaudio.h"
+
+int main(void);
+int main(void)
+{
+    PaError err;
+
+    printf("PortAudio Test: initialize and terminate.\n");
+
+    err = Pa_Initialize();
+    if( err != paNoError ) {
+        fprintf( stderr, "An error occurred while initializing PortAudio\n" );
+        goto error;
+    }
+
+    err = Pa_Terminate();
+    if( err != paNoError ) {
+        fprintf( stderr, "An error occurred while terminating PortAudio\n" );
+        goto error;
+    }
+
+    printf("Test completed successfully.\n");
+    return err;
+
+error:
+    Pa_Terminate();
+
+    fprintf( stderr, "Error number: %d\n", err );
+    fprintf( stderr, "Error message: %s\n", Pa_GetErrorText( err ) );
+    return err;
+}