gem v1.1.0 fails to install on openSUSE due to lib64 naming conventions

[mbixby17451]

Installing the latest v1.1.0 gem on openSUSE (Leap 42.2) fails because although the bundled freetds correctly builds into a "lib64" subdirectory per openSUSE naming conventions, the gem's extconf.rb is hard-coded to look for freetds in a "lib" subdirectory.

Output from gem install:

markb@linux:~> gem install tiny_tds
Fetching: mini_portile2-2.1.0.gem (100%)
Successfully installed mini_portile2-2.1.0
Fetching: tiny_tds-1.1.0.gem (100%)
Building native extensions.  This could take a while...
ERROR:  Error installing tiny_tds:
        ERROR: Failed to build gem native extension.

    current directory: /home/markb/stack/lib64/ruby/gems/2.3.0/gems/tiny_tds-1.1.0/ext/tiny_tds
/home/markb/stack/bin/ruby -r ./siteconf20170109-3991-kqksju.rb extconf.rb
extconf.rb:14: warning: already initialized constant OpenSSL::SSL::VERIFY_PEER
checking for sybfront.h... no
Downloading freetds-1.00.21.tar.bz2 (100%) 
Extracting freetds-1.00.21.tar.bz2 into tmp/x86_64-pc-linux-gnu/ports/freetds/1.00.21... OK
Running git apply with /home/markb/stack/lib64/ruby/gems/2.3.0/gems/tiny_tds-1.1.0/ports/patches/freetds/1.00.21/0001-mingw_missing_inet_pton.diff... OK
Running 'configure' for freetds 1.00.21... OK
Running 'compile' for freetds 1.00.21... OK
Running 'install' for freetds 1.00.21... OK
Activating freetds 1.00.21 (from /home/markb/stack/lib64/ruby/gems/2.3.0/gems/tiny_tds-1.1.0/ports/x86_64-pc-linux-gnu)...
checking for sybfront.h... yes
checking for sybdb.h... yes
checking for tdsdbopen() in -lsybdb... no
-----
freetds is missing.
Do you have FreeTDS 0.95.80 or higher installed?
-----
*** extconf.rb failed ***
Could not create Makefile due to some reason, probably lack of necessary
libraries and/or headers.  Check the mkmf.log file for more details.  You may
need configuration options.

Provided configuration options:
        --with-opt-dir
        --with-opt-include
        --without-opt-include=${opt-dir}/include
        --with-opt-lib
        --without-opt-lib=${opt-dir}/lib64
        --with-make-prog
        --without-make-prog
        --srcdir=.
        --curdir
        --ruby=/home/markb/stack/bin/$(RUBY_BASE_NAME)
        --help
        --enable-lookup
        --disable-lookup
        --with-freetds-dir
        --without-freetds-dir
        --with-freetds-include
        --without-freetds-include=${freetds-dir}/include
        --with-freetds-lib
        --without-freetds-lib=${freetds-dir}/lib64
        --enable-system-freetds
        --disable-system-freetds
        --enable-system-iconv
        --disable-system-iconv
        --enable-system-openssl
        --disable-system-openssl
        --enable-gnutls
        --disable-gnutls
        --enable-openssl
        --disable-openssl
        --with-freetds-dir
        --without-freetds-dir
        --with-freetds-include
        --without-freetds-include=${freetds-dir}/include
        --with-freetds-lib
        --without-freetds-lib=${freetds-dir}/lib64
        --with-sybdblib
        --without-sybdblib

To see why this extension failed to compile, please check the mkmf.log which can be found here:

  /home/markb/stack/lib64/ruby/gems/2.3.0/extensions/x86_64-linux/2.3.0-static/tiny_tds-1.1.0/mkmf.log

extconf failed, exit code 1

Gem files will remain installed in /home/markb/stack/lib64/ruby/gems/2.3.0/gems/tiny_tds-1.1.0 for inspection.
Results logged to /home/markb/stack/lib64/ruby/gems/2.3.0/extensions/x86_64-linux/2.3.0-static/tiny_tds-1.1.0/gem_make.out

Contents of mkmf.log:

markb@linux:~> cat /home/markb/stack/lib64/ruby/gems/2.3.0/extensions/x86_64-linux/2.3.0-static/tiny_tds-1.1.0/mkmf.log
have_header: checking for sybfront.h... -------------------- no

"gcc -o conftest -I/home/markb/stack/include/ruby-2.3.0/x86_64-linux -I/home/markb/stack/include/ruby-2.3.0/ruby/backward -I/home/markb/stack/include/ruby-2.3.0 -I. -I/usr/local/include -I/usr/include  -I/home/markb/stack/include    -O3 -fno-fast-math -ggdb3 -Wall -Wextra -Wno-unused-parameter -Wno-parentheses -Wno-long-long -Wno-missing-field-initializers -Wunused-variable -Wpointer-arith -Wwrite-strings -Wdeclaration-after-statement -Wimplicit-function-declaration -Wdeprecated-declarations -Wno-packed-bitfield-compat  conftest.c  -L. -L/home/markb/stack/lib64 -Wl,-R/home/markb/stack/lib64 -L/usr/local/lib -Wl,-R/usr/local/lib -L/usr/lib -Wl,-R/usr/lib -L/home/markb/stack/lib64 -Wl,-R/home/markb/stack/lib64 -L. -fstack-protector -rdynamic -Wl,-export-dynamic -L/home/markb/stack/lib  -Wl,-R/home/markb/stack/lib      -Wl,-R/home/markb/stack/lib64 -L/home/markb/stack/lib64 -lruby-static  -lpthread -lgmp -ldl -lcrypt -lm   -lc "
checked program was:
/* begin */
1: #include "ruby.h"
2: 
3: int main(int argc, char **argv)
4: {
5:   return 0;
6: }
/* end */

"gcc -E -I/home/markb/stack/include/ruby-2.3.0/x86_64-linux -I/home/markb/stack/include/ruby-2.3.0/ruby/backward -I/home/markb/stack/include/ruby-2.3.0 -I. -I/usr/local/include -I/usr/include  -I/home/markb/stack/include    -O3 -fno-fast-math -ggdb3 -Wall -Wextra -Wno-unused-parameter -Wno-parentheses -Wno-long-long -Wno-missing-field-initializers -Wunused-variable -Wpointer-arith -Wwrite-strings -Wdeclaration-after-statement -Wimplicit-function-declaration -Wdeprecated-declarations -Wno-packed-bitfield-compat   conftest.c -o conftest.i"
conftest.c:3:22: fatal error: sybfront.h: No such file or directory
 #include <sybfront.h>
                      ^
compilation terminated.
checked program was:
/* begin */
1: #include "ruby.h"
2: 
3: #include <sybfront.h>
/* end */

--------------------

have_header: checking for sybfront.h... -------------------- yes

"gcc -E -I/home/markb/stack/include/ruby-2.3.0/x86_64-linux -I/home/markb/stack/include/ruby-2.3.0/ruby/backward -I/home/markb/stack/include/ruby-2.3.0 -I. -I/home/markb/stack/lib64/ruby/gems/2.3.0/gems/tiny_tds-1.1.0/ports/x86_64-pc-linux-gnu/include -I/usr/local/include -I/usr/include  -I/home/markb/stack/include    -O3 -fno-fast-math -ggdb3 -Wall -Wextra -Wno-unused-parameter -Wno-parentheses -Wno-long-long -Wno-missing-field-initializers -Wunused-variable -Wpointer-arith -Wwrite-strings -Wdeclaration-after-statement -Wimplicit-function-declaration -Wdeprecated-declarations -Wno-packed-bitfield-compat   conftest.c -o conftest.i"
checked program was:
/* begin */
1: #include "ruby.h"
2: 
3: #include <sybfront.h>
/* end */

--------------------

have_header: checking for sybdb.h... -------------------- yes

"gcc -E -I/home/markb/stack/include/ruby-2.3.0/x86_64-linux -I/home/markb/stack/include/ruby-2.3.0/ruby/backward -I/home/markb/stack/include/ruby-2.3.0 -I. -I/home/markb/stack/lib64/ruby/gems/2.3.0/gems/tiny_tds-1.1.0/ports/x86_64-pc-linux-gnu/include -I/usr/local/include -I/usr/include  -I/home/markb/stack/include    -O3 -fno-fast-math -ggdb3 -Wall -Wextra -Wno-unused-parameter -Wno-parentheses -Wno-long-long -Wno-missing-field-initializers -Wunused-variable -Wpointer-arith -Wwrite-strings -Wdeclaration-after-statement -Wimplicit-function-declaration -Wdeprecated-declarations -Wno-packed-bitfield-compat   conftest.c -o conftest.i"
checked program was:
/* begin */
1: #include "ruby.h"
2: 
3: #include <sybdb.h>
/* end */

--------------------

find_library: checking for tdsdbopen() in -lsybdb... -------------------- no

"gcc -o conftest -I/home/markb/stack/include/ruby-2.3.0/x86_64-linux -I/home/markb/stack/include/ruby-2.3.0/ruby/backward -I/home/markb/stack/include/ruby-2.3.0 -I. -I/home/markb/stack/lib64/ruby/gems/2.3.0/gems/tiny_tds-1.1.0/ports/x86_64-pc-linux-gnu/include -I/usr/local/include -I/usr/include  -I/home/markb/stack/include    -O3 -fno-fast-math -ggdb3 -Wall -Wextra -Wno-unused-parameter -Wno-parentheses -Wno-long-long -Wno-missing-field-initializers -Wunused-variable -Wpointer-arith -Wwrite-strings -Wdeclaration-after-statement -Wimplicit-function-declaration -Wdeprecated-declarations -Wno-packed-bitfield-compat  conftest.c  -L. -L/home/markb/stack/lib64 -Wl,-R/home/markb/stack/lib64 -L/home/markb/stack/lib64/ruby/gems/2.3.0/gems/tiny_tds-1.1.0/ports/x86_64-pc-linux-gnu/lib -Wl,-R/home/markb/stack/lib64/ruby/gems/2.3.0/gems/tiny_tds-1.1.0/ports/x86_64-pc-linux-gnu/lib -L/usr/local/lib -Wl,-R/usr/local/lib -L/usr/lib -Wl,-R/usr/lib -L/home/markb/stack/lib64 -Wl,-R/home/markb/stack/lib64 -L. -fstack-protector -rdynamic -Wl,-export-dynamic -L/home/markb/stack/lib  -Wl,-R/home/markb/stack/lib      -Wl,-R/home/markb/stack/lib64 -L/home/markb/stack/lib64 -lruby-static -lsybdb  -lpthread -lgmp -ldl -lcrypt -lm   -lc "
conftest.c: In function ‘t’:
conftest.c:13:57: error: ‘tdsdbopen’ undeclared (first use in this function)
 int t(void) { void ((*volatile p)()); p = (void ((*)()))tdsdbopen; return !p; }
                                                         ^
conftest.c:13:57: note: each undeclared identifier is reported only once for each function it appears in
checked program was:
/* begin */
 1: #include "ruby.h"
 2: 
 3: /*top*/
 4: extern int t(void);
 5: int main(int argc, char **argv)
 6: {
 7:   if (argc > 1000000) {
 8:     printf("%p", &t);
 9:   }
10: 
11:   return 0;
12: }
13: int t(void) { void ((*volatile p)()); p = (void ((*)()))tdsdbopen; return !p; }
/* end */

"gcc -o conftest -I/home/markb/stack/include/ruby-2.3.0/x86_64-linux -I/home/markb/stack/include/ruby-2.3.0/ruby/backward -I/home/markb/stack/include/ruby-2.3.0 -I. -I/home/markb/stack/lib64/ruby/gems/2.3.0/gems/tiny_tds-1.1.0/ports/x86_64-pc-linux-gnu/include -I/usr/local/include -I/usr/include  -I/home/markb/stack/include    -O3 -fno-fast-math -ggdb3 -Wall -Wextra -Wno-unused-parameter -Wno-parentheses -Wno-long-long -Wno-missing-field-initializers -Wunused-variable -Wpointer-arith -Wwrite-strings -Wdeclaration-after-statement -Wimplicit-function-declaration -Wdeprecated-declarations -Wno-packed-bitfield-compat  conftest.c  -L. -L/home/markb/stack/lib64 -Wl,-R/home/markb/stack/lib64 -L/home/markb/stack/lib64/ruby/gems/2.3.0/gems/tiny_tds-1.1.0/ports/x86_64-pc-linux-gnu/lib -Wl,-R/home/markb/stack/lib64/ruby/gems/2.3.0/gems/tiny_tds-1.1.0/ports/x86_64-pc-linux-gnu/lib -L/usr/local/lib -Wl,-R/usr/local/lib -L/usr/lib -Wl,-R/usr/lib -L/home/markb/stack/lib64 -Wl,-R/home/markb/stack/lib64 -L. -fstack-protector -rdynamic -Wl,-export-dynamic -L/home/markb/stack/lib  -Wl,-R/home/markb/stack/lib      -Wl,-R/home/markb/stack/lib64 -L/home/markb/stack/lib64 -lruby-static -lsybdb  -lpthread -lgmp -ldl -lcrypt -lm   -lc "
/usr/lib64/gcc/x86_64-suse-linux/4.8/../../../../x86_64-suse-linux/bin/ld: cannot find -lsybdb
collect2: error: ld returned 1 exit status
checked program was:
/* begin */
 1: #include "ruby.h"
 2: 
 3: /*top*/
 4: extern int t(void);
 5: int main(int argc, char **argv)
 6: {
 7:   if (argc > 1000000) {
 8:     printf("%p", &t);
 9:   }
10: 
11:   return 0;
12: }
13: extern void tdsdbopen();
14: int t(void) { tdsdbopen(); return 0; }
/* end */

--------------------

[mbixby17451]

Pull request #334 submitted.

[metaskills]

Thanks!!! The extconf.rb downloading and building FreeTDS is meant for the Windows binaries that we precompile and distribute. It is not really meant to facilitate builds for all platforms. From our install section https://github.com/rails-sqlserver/tiny_tds#install

It is recommended that you install the latest FreeTDS via your method of choice. For example, here is how to install FreeTDS on Ubuntu....

Is openSUSE able to install FreeTDS and the supporting OpenSSL on its own?

[coderjoe]

@metaskills this makes me wonder if there's a way to only prebuild openssl and freetds only for the windows packaged binaries and not for everything else. I'm going to have to ponder that for a while.

Related: If auto-downloading and building openssl and freetds on non-windows platforms went away, would that be too radical a change?

[metaskills]

If auto-downloading and building openssl and freetds on non-windows platforms went away, would that be too radical a change?

I hope not. It might head off support issues on making a mini port system for one platform work for all. Perhaps we can make that a small change that allows the full mechanics to work when either RUBY_CC_VERSION or some other env is present.

[coderjoe]

I may toy with this the next time I get some free hack-time. No promises when I'm next going to get hack-time though :'(

[metaskills]

I may toy with this the next time I get some free hack-time

I would not worry about, I can update the docs a bit more. Not really a priority.

[mbixby17451]

I was actually already building my own freetds (in a non-system location specified by appropriate library path env vars) to use with tiny_tds on Linux distros, from the days before freetds was bundled with the gem.

My recent failed gem install on openSUSE was probably the first time I've tried to deploy tiny_tds there since bundling was implemented. The default algorithm without any tiny_tds options being specified elected to build the bundled freetds (which failed due to lib64). I thought hmmm, maybe I should just rely on the bundled version to be in sync with what the development team tests with, so I fixed the bundling case to handle lib64.

But then I later decided no, I'll stick with my own separate build of freetds, and so I'm now installing tiny_tds with the --with-freetds-dir option pointing to my freetds, and that works fine on unpatched v1.1.0.

I no longer have a personal need for the original problem to be fixed, but I provided a fix in case it was of interest to others. If the intent is for bundling to only be relevant on non-Linux platforms, that's no problem for me since I don't deploy there.

[metaskills]

The default algorithm without any tiny_tds options being specified elected to build the bundled freetds (which failed due to lib64).

Yea, IMO that build is not expected for most gems and we really should encourage you to install the needed dependencies needed or as you pointed out, point the gem install to the proper directories.

but I provided a fix in case it was of interest to others

Really appreciate that!

[coderjoe]

@mbixby17451 your PR is very much appreciated. :)

[metaskills]

Closing, please see #342 for details.