facter 2.5.7 → 3.9.6.cfacter.20180606

data/ext/facter/extconf.rb

@@ -0,0 +1,22 @@
+require 'mkmf'
+require 'erb'
+
+cmake_binary = find_executable('cmake')
+source_root = File.expand_path("#{__FILE__}/..")
+cmake_opts = ENV['FACTER_CMAKE_OPTS']
+
+if RbConfig::CONFIG['arch'].include?('mingw')
+  windows_native_source = source_root.gsub('/', '\\')
+  # xcopy will make the libdir for us, so there's no mkdir for windows
+  install_command = "xcopy \"prefix\\bin\\*facter*\" \"#{windows_native_source}\\..\\..\\bin\" /i && xcopy \"prefix\\lib\\*facter*\" \"#{windows_native_source}\\..\\..\\lib\" /i"
+  touch_command = 'type nul >'
+  mkdir_command = 'mkdir'
+else
+  install_command = "mkdir -p #{source_root}/../../lib && cp prefix/lib/*facter* #{source_root}/../../lib"
+  touch_command = 'touch'
+  mkdir_command = 'mkdir -p'
+end
+
+make_template = File.open(source_root+"/Makefile.erb").read
+makefile = ERB.new(make_template).result(binding)
+File.write('Makefile', makefile)

data/ext/facter/facter/CMakeLists.txt

@@ -0,0 +1,183 @@
+cmake_minimum_required(VERSION 3.2.2)
+project(FACTER VERSION 3.9.6)
+
+# Set this early, so it's available. AIX gets weird, man.
+if("${CMAKE_SYSTEM_NAME}" MATCHES "AIX")
+    set(AIX TRUE)
+endif()
+
+if (NOT CMAKE_BUILD_TYPE)
+    message(STATUS "Defaulting to a release build.")
+    set(CMAKE_BUILD_TYPE "Release" CACHE STRING "Choose the type of build, options are: None Debug Release RelWithDebInfo MinSizeRel." FORCE)
+endif()
+
+option(YAMLCPP_STATIC "Use yaml-cpp's static libraries" OFF)
+option(BUILD_SHARED_LIBS "Build libfacter as a shared library" ON)
+
+set(FACTER_PATH "" CACHE PATH "Specify the location to look for specific binaries before trying PATH.")
+if (FACTER_PATH)
+    # Specify a preferred location for binary lookup that will be prioritized over PATH.
+    file(TO_CMAKE_PATH ${FACTER_PATH} FACTER_PATH_FIXED)
+    add_definitions(-DFACTER_PATH="${FACTER_PATH_FIXED}")
+    message(STATUS "Prioritizing binary lookup in ${FACTER_PATH_FIXED}")
+endif()
+
+set(FACTER_RUBY "" CACHE FILEPATH "Specify the location of libruby at compile-time, bypassing dynamic lookup.")
+if (FACTER_RUBY)
+    file(TO_CMAKE_PATH ${FACTER_RUBY} FACTER_RUBY_PATH)
+    add_definitions(-DFACTER_RUBY="${FACTER_RUBY_PATH}")
+    message(STATUS "Fixing lookup for libruby to ${FACTER_RUBY_PATH}")
+endif()
+
+set(AIO_AGENT_VERSION "" CACHE STRING "Creates an aio_agent_version fact with the specified value.")
+if (AIO_AGENT_VERSION)
+    add_definitions(-DAIO_AGENT_VERSION="${AIO_AGENT_VERSION}")
+    message(STATUS "Adding fact aio_agent_version=${AIO_AGENT_VERSION}")
+endif()
+
+enable_testing()
+
+list(APPEND CMAKE_MODULE_PATH "${PROJECT_SOURCE_DIR}/cmake")
+
+if ("${CMAKE_SYSTEM_NAME}" MATCHES "Darwin")
+    # Allow searching in boxen installed homebrew directories
+    # http://stackoverflow.com/questions/1487752/how-do-i-instruct-cmake-to-look-for-libraries-installed-by-macports
+    set(CMAKE_LIBRARY_PATH ${CMAKE_LIBRARY_PATH} /opt/boxen/homebrew/lib)
+    set(CMAKE_INCLUDE_PATH ${CMAKE_INCLUDE_PATH} /opt/boxen/homebrew/include)
+endif()
+
+include(FeatureSummary)
+
+SET(LEATHERMAN_COMPONENTS locale catch nowide logging util file_util dynamic_library execution ruby rapidjson)
+
+# We look for curl early, because whether or not we link to the leatherman curl library
+# is dependant on whether or not we find curl on the system.
+if ((("${CMAKE_SYSTEM_NAME}" MATCHES "Linux|OpenBSD") OR WIN32) AND NOT WITHOUT_CURL)
+    find_package(CURL)
+    if (CURL_FOUND)
+        add_definitions(-DUSE_CURL)
+        list(APPEND LEATHERMAN_COMPONENTS curl)
+    endif()
+    set_package_properties(CURL PROPERTIES DESCRIPTION "A free and easy-to-use client-side URL transfer library" URL "http://curl.haxx.se/libcurl/")
+    set_package_properties(CURL PROPERTIES TYPE OPTIONAL PURPOSE "Enables facts that require HTTP.")
+endif()
+
+if (WIN32)
+    list(APPEND LEATHERMAN_COMPONENTS windows)
+endif()
+
+find_package(Leatherman REQUIRED COMPONENTS ${LEATHERMAN_COMPONENTS})
+
+# Now that we have leatherman, we can pulll in its options file, which
+# we need for finding all our other libraries.
+include(options)
+
+if (LEATHERMAN_USE_LOCALES)
+    add_definitions(-DLEATHERMAN_I18N)
+    SET(BOOST_COMPONENTS locale)
+endif()
+
+# We use program_options, system, filesystem, date_time, and regex directly. Testing uses thread and chrono.
+list(APPEND BOOST_COMPONENTS program_options system filesystem date_time regex thread chrono)
+
+find_package(Boost 1.54 REQUIRED COMPONENTS ${BOOST_COMPONENTS})
+# date_time and regex need threads on some platforms, and find_package Boost only includes
+# pthreads if you require the Boost.Thread component.
+find_package(Threads)
+
+find_package(Ruby 1.9)
+
+find_package(YAMLCPP REQUIRED)
+if (NOT WITHOUT_OPENSSL)
+    find_package(OPENSSL)
+endif()
+if ("${CMAKE_SYSTEM_NAME}" MATCHES "Linux" AND NOT WITHOUT_BLKID)
+    find_package(BLKID)
+endif()
+
+find_package(CPPHOCON REQUIRED)
+
+find_package(WHEREAMI)
+if (WHEREAMI_FOUND)
+    add_definitions(-DUSE_WHEREAMI)
+endif()
+
+if (NOT WITHOUT_JRUBY AND NOT WIN32)
+    find_package(JNI)
+    set_package_properties(JNI PROPERTIES DESCRIPTION "Java Native Interface (JNI) is a programming framework that enables Java code running in a Java Virtual Machine (JVM) to call and be called by native applications.")
+    set_package_properties(JNI PROPERTIES TYPE OPTIONAL PURPOSE "Enables JRuby support in Facter.")
+
+    if (JNI_FOUND)
+        find_package(Java)
+        set_package_properties(Java PROPERTIES DESCRIPTION "Java compiler for JNI.")
+        set_package_properties(Java PROPERTIES TYPE OPTIONAL PURPOSE "Enables JRuby support in Facter.")
+
+        if (Java_JAVAC_EXECUTABLE)
+            set(JRUBY_SUPPORT TRUE)
+            set(CMAKE_JAVA_COMPILE_FLAGS -source 1.6 -target 1.6)
+            add_definitions(-DUSE_JRUBY_SUPPORT)
+        endif()
+    endif()
+endif()
+
+# Display a summary of the features
+include(FeatureSummary)
+feature_summary(WHAT ALL)
+
+# Set RPATH if not installing to a system library directory
+list(FIND CMAKE_PLATFORM_IMPLICIT_LINK_DIRECTORIES "${CMAKE_INSTALL_PREFIX}/lib" INSTALL_IS_SYSTEM_DIR)
+if ("${INSTALL_IS_SYSTEM_DIR}" STREQUAL "-1")
+    set(CMAKE_INSTALL_RPATH "${CMAKE_INSTALL_PREFIX}/lib")
+endif()
+
+# Pull in common cflags setting from leatherman
+include(cflags)
+set(FACTER_CXX_FLAGS "${LEATHERMAN_CXX_FLAGS}")
+add_definitions(${LEATHERMAN_DEFINITIONS})
+
+# Enable DEP/ASLR switches on windows versions
+if (WIN32)
+    set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -Wl,--nxcompat -Wl,--dynamicbase")
+endif()
+
+#
+# Add cpplint and cppcheck targets
+#
+file(GLOB_RECURSE ALL_SOURCES lib/src/*.cc lib/inc/*.hpp lib/inc/*.h exe/*.cc exe/*.hpp exe/*.h)
+add_cpplint_files(${ALL_SOURCES})
+enable_cpplint()
+
+add_cppcheck_dirs("${PROJECT_SOURCE_DIR}/lib" "${PROJECT_SOURCE_DIR}/exe")
+enable_cppcheck()
+
+# Pull in helper macros for working with leatherman libraries
+include(leatherman)
+
+add_subdirectory(lib)
+add_subdirectory(exe)
+add_subdirectory(locales)
+
+# Add test executables for unit testing
+add_test(NAME "libfacter\\ tests" COMMAND libfacter_test)
+if (RUBY_FOUND)
+    find_program(BUNDLER_PATH NAMES bundle.bat bundle)
+    if (BUNDLER_PATH)
+        add_test(NAME "libfacter\\ specs" COMMAND ${BUNDLER_PATH} exec rspec WORKING_DIRECTORY "${PROJECT_SOURCE_DIR}/lib")
+    endif()
+endif()
+add_test(NAME "facter\\ smoke" COMMAND facter)
+
+# Install the man page
+if ("${CMAKE_SYSTEM_NAME}" MATCHES "OpenBSD|FreeBSD")
+    set(MANDIR man/man8/)
+else()
+    set(MANDIR share/man/man8/)
+endif()
+
+option(INSTALL_BATCH_FILES "Generate .bat files during installation" ON)
+install(FILES ${PROJECT_SOURCE_DIR}/man/man8/facter.8 DESTINATION ${MANDIR})
+if (WIN32 AND INSTALL_BATCH_FILES)
+  install(FILES ${PROJECT_SOURCE_DIR}/ext/windows/facter.bat DESTINATION ${CMAKE_INSTALL_PREFIX}/bin)
+  install(FILES ${PROJECT_SOURCE_DIR}/ext/windows/facter_interactive.bat DESTINATION ${CMAKE_INSTALL_PREFIX}/bin)
+  install(FILES ${PROJECT_SOURCE_DIR}/ext/windows/run_facter_interactive.bat DESTINATION ${CMAKE_INSTALL_PREFIX}/bin)
+endif()

data/ext/facter/facter/CONTRIBUTING.md

@@ -0,0 +1,99 @@
+# How to contribute
+
+Third-party patches are essential for keeping facter great. We simply can't
+access the huge number of platforms and myriad configurations for running
+facter. We want to keep it as easy as possible to contribute changes that
+get things working in your environment. There are a few guidelines that we
+need contributors to follow so that we can have a chance of keeping on
+top of things.
+
+## Getting Started
+
+* Make sure you have a [Jira account](http://tickets.puppetlabs.com)
+* Make sure you have a [GitHub account](https://github.com/signup/free)
+* Submit a ticket for your issue, assuming one does not already exist.
+  * Clearly describe the issue including steps to reproduce when it is a bug.
+  * Make sure you fill in the earliest version that you know has the issue.
+* Fork the repository on GitHub
+
+## New Facts
+
+All new facts should also be included in `lib/schema/facter.yaml`. Without this
+facts won't pass acceptance tests.
+
+## Making Changes
+
+* Create a topic branch from where you want to base your work.
+  * This is usually the master branch.
+  * Only target release branches if you are certain your fix must be on that
+    branch.
+  * To quickly create a topic branch based on master; `git branch
+    fix/master/my_contribution master` then checkout the new branch with `git
+    checkout fix/master/my_contribution`.  Please avoid working directly on the
+    `master` branch.
+* Make commits of logical units.
+* Check for unnecessary whitespace with `git diff --check` before committing.
+* If you have python 2 in your path you can run `make cpplint` to ensure your
+  code formatting is clean. The linter runs as part of Travis CI and could fail
+  the CI build.
+* If you have cppcheck in your path you can run `make cppcheck` to ensure your
+  code passes static analysis. cppcheck runs as part of Travis CI and could
+  fail the CI build.
+* Make sure your commit messages are in the proper format.
+
+````
+    (FACT-1234) Make the example in CONTRIBUTING imperative and concrete
+
+    Without this patch applied the example commit message in the CONTRIBUTING
+    document is not a concrete example.  This is a problem because the
+    contributor is left to imagine what the commit message should look like
+    based on a description rather than an example.  This patch fixes the
+    problem by making the example concrete and imperative.
+
+    The first line is a real life imperative statement with a ticket number
+    from our issue tracker.  The body describes the behavior without the patch,
+    why this is a problem, and how the patch fixes the problem when applied.
+````
+
+* Make sure you have added the necessary tests for your changes.
+* Run _all_ the tests to assure nothing else was accidentally broken.
+
+## Making Trivial Changes
+
+### Documentation
+
+For changes of a trivial nature to comments and documentation, it is not
+always necessary to create a new ticket in Jira. In this case, it is
+appropriate to start the first line of a commit with '(doc)' instead of
+a ticket number.
+
+````
+    (doc) Add documentation commit example to CONTRIBUTING
+
+    There is no example for contributing a documentation commit
+    to the Facter repository. This is a problem because the contributor
+    is left to assume how a commit of this nature may appear.
+
+    The first line is a real life imperative statement with '(doc)' in
+    place of what would have been the ticket number in a
+    non-documentation related commit. The body describes the nature of
+    the new documentation or comments added.
+````
+
+## Submitting Changes
+
+* Sign the [Contributor License Agreement](http://links.puppet.com/cla).
+* Push your changes to a topic branch in your fork of the repository.
+* Submit a pull request to the repository in the puppetlabs organization.
+* Update your ticket to mark that you have submitted code and are ready for it to be reviewed.
+  * Include a link to the pull request in the ticket
+
+# Additional Resources
+
+* [Puppet community guidelines](https://docs.puppet.com/community/community_guidelines.html)
+* [Bug tracker (Jira)](https://tickets.puppetlabs.com/browse/FACT)
+* [Contributor License Agreement](http://links.puppet.com/cla)
+* [General GitHub documentation](http://help.github.com/)
+* [GitHub pull request documentation](http://help.github.com/send-pull-requests/)
+* #puppet-dev IRC channel on freenode.org
+* [puppet-dev mailing list](https://groups.google.com/forum/#!forum/puppet-dev)

data/ext/facter/facter/Extensibility.md

@@ -0,0 +1,133 @@
+Extensibility
+=============
+
+Native Facter has the following extensibility goals:
+
+* Clear guidelines for what facts are supported in-project
+* Compatibility with 90+% of existing Facter custom facts
+* Compatibility with 100% of existing Facter external facts
+* New features for external facts, including depends/requires logic
+
+The following sections discuss those goals in more depth.
+
+Note that this doc is work-in-progress and should be updated as extensibility features are implemented, refined or ruled out.
+
+Built-in facts
+--------------
+
+These are the criteria for Native Facter pull requests:
+
+* Additional resolutions for existing built-in facts (e.g. the operatingsystem facts for new Linux Distros) must conform to the facter.json schema.
+* New facts must be accompanied by support in the facter.json schema.
+* For [SemVer](http://semver.org) purposes, a change in fact value is only considered breaking if a) the fact is documented in the schema, and b) the fact is applicable on a platform we test against in [Puppet CI](http://jenkins.puppetlabs.com).
+
+Custom Facts Compatibility
+--------------------------
+
+Ruby Facter supports "custom facts" that are facts implemented using the public Facter API.
+
+Native Facter implements a Ruby compatibility layer to support simple and aggregate fact resolutions.
+Native Facter searches for a MRI Ruby library to load and initializes a Ruby VM as needed
+to resolve custom facts.
+
+The environment variable `LEATHERMAN_RUBY` can be used to explicitly instruct native Facter to use
+a particular Ruby library (e.g. `LEATHERMAN_RUBY=/usr/local/lib/libruby.so.1.9.3`).  If not set, native Facter will search for and load the highest
+version Ruby library on the system.
+
+**Ruby 1.8.x is not supported by native Facter.  Please use Ruby 1.9.3 or later.**
+
+Native Facter will load custom facts from the following locations:
+
+* Any Ruby source file in a `facter` subdirectory on the Ruby load path.
+* Any Ruby source file in a directory specified by the `FACTERLIB` environment variable (delimited by the platform PATH separator).
+* Any Ruby source file in a directory specified by the `--custom-dir` option to facter.
+
+The following methods from the Facter API are currently supported by native Facter:
+
+From the `Facter` module:
+
+* []
+* add
+* clear
+* debug
+* debugonce
+* define_fact
+* each
+* fact
+* flush
+* list
+* loadfacts
+* log_exception
+* reset
+* search
+* search_path
+* search_external
+* search_external_path
+* to_hash
+* value
+* version
+* warn
+* warnonce
+
+From the `Facter::Core::Execution` module:
+
+* which
+* exec
+* execute
+* ExecutionFailure
+
+From the `Facter::Util::Fact` class:
+
+* define_resolution
+* flush
+* name
+* resolution
+* value
+
+From the `Facter::Util::Resolution` module:
+
+* confine
+* exec
+* has_weight
+* name
+* on_flush
+* setcode
+* which
+
+From the `Facter::Core::Aggregate` module:
+
+* aggregate
+* chunk
+* confine
+* has_weight
+* name
+* on_flush
+
+Please note: the timeout option is not currently supported on resolutions.  Setting a timeout will result in a warning
+and the timeout will be ignored.
+
+Please see the [Facter Custom Facts Walkthrough](https://docs.puppetlabs.com/facter/2.2/custom_facts.html) for more information on using the Facter API.
+
+External Facts Compatiblity
+---------------------------
+
+Native Facter will support all 4 forms of "external facts" which Ruby Facter supports:
+* JSON files with the .json extension whose key-value pairs will be mapped to fact-value pairs.
+* YAML files with the .yaml extension whose key-value pairs will be mapped to fact-value pairs.
+* Text files with the .txt extension containing `fact=some_value` strings
+* Executable files returning `fact=some_value` strings
+
+New Features for External Facts
+-------------------------------
+
+Caveat: It is TBD which of these features will be implemented in what releases.
+
+* Executable external facts can take a json object on stdin describing all known facts. This will allow logic like the confine/value methods provide in the custom facts API.
+
+* To support the use case of facts which depend on other facts: executable external facts can describe what facts they depend on and what facts they provide, via a json schema. (This schema could either be a parallel file distributed with the external fact following some naming convention (e.g. foo.schema for an external fact called foo.sh or foo.py), or the schema could be provided on stdout when executing the external fact with some parameter (e.g. foo.sh --show-schema).) 
+
+* Native Facter might add a weight indicator for returned facts, to support fact precedence for external facts, along the lines of the `has_weight` functionality.
+
+* Native Facter might add a volatility indicator, such as a ttl field, to the json schema provided by external facts. This would allow facter in a long-running process to avoid unnecessary refreshes of non-volatile facts.
+
+* Native Facter might include some language-specific shims for its external facts support, most likely for Ruby and Python, to ease writing new external facts (including ports of legacy custom facts).

data/ext/facter/facter/LICENSE

@@ -0,0 +1,17 @@
+   facter - Tool for collecting system facts.
+
+   Copyright (C) 2014 Puppet Labs Inc
+
+   Puppet Labs can be contacted at: info@puppetlabs.com
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.