external_include_replacer_test.go

/*
 * This file is part of Arduino Builder.
 *
 * Arduino Builder is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * As a special exception, you may use this file as part of a free software
 * library without restriction.  Specifically, if other files instantiate
 * templates or use macros or inline functions from this file, or you compile
 * this file and link it with other files to produce an executable, this
 * file does not by itself cause the resulting executable to be covered by
 * the GNU General Public License.  This exception does not however
 * invalidate any other reasons why the executable file might be covered by
 * the GNU General Public License.
 *
 * Copyright 2015 Arduino LLC (http://www.arduino.cc/)
 */

package test

import (
	"arduino.cc/builder"
	"arduino.cc/builder/constants"
	"github.com/stretchr/testify/require"
	"testing"
)

var sourceWithIncludes = "#line 1 \"sketch_with_config.ino\"\n" +
	"#include \"config.h\"\n" +
	"\n" +
	"#ifdef DEBUG\n" +
	"#include \"includes/de bug.h\"\n" +
	"#endif\n" +
	"\n" +
	"#include <Bridge.h>\n" +
	"\n" +
	"void setup() {\n" +
	"\n" +
	"}\n" +
	"\n" +
	"void loop() {\n" +
	"\n" +
	"}\n"

var sourceWithPragmas = "#line 1 \"sketch_with_config.ino\"\n" +
	"#include \"config.h\"\n" +
	"\n" +
	"#ifdef DEBUG\n" +
	"#include \"includes/de bug.h\"\n" +
	"#endif\n" +
	"\n" +
	"#pragma ___MY_INCLUDE___ <Bridge.h>\n" +
	"\n" +
	"void setup() {\n" +
	"\n" +
	"}\n" +
	"\n" +
	"void loop() {\n" +
	"\n" +
	"}\n"

func TestExternalIncludeReplacerIncludeToPragma(t *testing.T) {
	context := make(map[string]interface{})
	context[constants.CTX_SOURCE] = sourceWithIncludes
	context[constants.CTX_INCLUDES] = []string{"/tmp/test184599776/sketch/config.h", "/tmp/test184599776/sketch/includes/de bug.h", "Bridge.h"}

	replacer := builder.ExternalIncludeReplacer{SourceKey: constants.CTX_SOURCE, TargetKey: constants.CTX_GCC_MINUS_E_SOURCE, From: "#include ", To: "#pragma ___MY_INCLUDE___ "}
	err := replacer.Run(context)
	NoError(t, err)

	require.Equal(t, sourceWithIncludes, context[constants.CTX_SOURCE].(string))
	require.Equal(t, sourceWithPragmas, context[constants.CTX_GCC_MINUS_E_SOURCE].(string))
}

func TestExternalIncludeReplacerPragmaToInclude(t *testing.T) {
	context := make(map[string]interface{})
	context[constants.CTX_GCC_MINUS_E_SOURCE] = sourceWithPragmas
	context[constants.CTX_INCLUDES] = []string{"/tmp/test184599776/sketch/config.h", "/tmp/test184599776/sketch/includes/de bug.h", "Bridge.h"}

	replacer := builder.ExternalIncludeReplacer{SourceKey: constants.CTX_GCC_MINUS_E_SOURCE, TargetKey: constants.CTX_GCC_MINUS_E_SOURCE, From: "#pragma ___MY_INCLUDE___ ", To: "#include "}
	err := replacer.Run(context)
	NoError(t, err)

	require.Nil(t, context[constants.CTX_SOURCE])
	require.Equal(t, sourceWithIncludes, context[constants.CTX_GCC_MINUS_E_SOURCE].(string))
}