feat!: move tests and helpers into (#459)

* test: move into `test` directory

* test: update import paths

* test: update jest config

* refactor: move test helpers

* test: move jest config into dedicated file

* docs: add changelog entry

* chore: remove unneeded eslint ignore

.eslintignore

@@ -1,4 +1,3 @@
 lib/*
 node_modules/*
 vendor/*
-**/__tests__/**/*

CHANGELOG.md

@@ -44,6 +44,8 @@ Changes since the last non-beta release.
 
 - Remove `isArray` utility (just use `Array.isArray` directly) and renamed a few files [PR 454](https://github.com/shakacode/shakapacker/pull/454) by [G-Rath](https://github.com/g-rath).
 
+- Make JavaScript test helper utilities internal (`chdirTestApp`, `chdirCwd`, `resetEnv`) [PR 458](https://github.com/shakacode/shakapacker/pull/458) by [G-Rath](https://github.com/g-rath).
+
 ## [v7.2.3] - March 23, 2024
 
 ### Added

jest.config.js

@@ -0,0 +1,7 @@
+module.exports = {
+ roots: ["<rootDir>/test"],
+ testPathIgnorePatterns: [
+ "/__fixtures__/",
+ "/__utils__/"
+ ]
+}

package.json

@@ -22,16 +22,6 @@
  "lint": "eslint package/",
  "test": "jest"
  },
- "jest": {
- "roots": [
- "<rootDir>/package"
- ],
- "testPathIgnorePatterns": [
- "/__fixtures__/",
- "/__utils__/"
- ],
- "testRegex": "(/__tests__/.*|(\\.|/))\\.jsx?$"
- },
  "dependencies": {
  "js-yaml": "^4.1.0",
  "path-complete-extname": "^1.0.0"

package/utils/helpers.js

@@ -1,17 +1,4 @@
 const isBoolean = (str) => /^true/.test(str) || /^false/.test(str)
-const chdirTestApp = () => {
- try {
- return process.chdir('spec/shakapacker/test_app')
- } catch (e) {
- return null
- }
-}
-
-const chdirCwd = () => process.chdir(process.cwd())
-
-const resetEnv = () => {
- process.env = {}
-}
 
 const ensureTrailingSlash = (path) => (path.endsWith('/') ? path : `${path}/`)
 
@@ -55,12 +42,9 @@ const loaderMatches = (configLoader, loaderToCheck, fn) => {
 }
 
 module.exports = {
- chdirTestApp,
- chdirCwd,
  isBoolean,
  ensureTrailingSlash,
  canProcess,
  moduleExists,
- resetEnv,
  loaderMatches
 }

package/rules/__tests__/__utils__/webpack.js → test/helpers.js

@@ -40,7 +40,24 @@ const createTestCompiler = (config, fs = createInMemoryFs()) => {
  return compiler;
 };
 
+const chdirTestApp = () => {
+ try {
+ return process.chdir('spec/shakapacker/test_app')
+ } catch (e) {
+ return null
+ }
+}
+
+const chdirCwd = () => process.chdir(process.cwd())
+
+const resetEnv = () => {
+ process.env = {}
+}
+
 module.exports = {
+ chdirTestApp,
+ chdirCwd,
+ resetEnv,
  createTrackLoader,
  node_modules,
  node_modules_included,

package/__tests__/config.js → test/package/config.test.js

@@ -1,27 +1,27 @@
 /* global test expect, describe */
 
-const { chdirTestApp, resetEnv } = require('../utils/helpers')
+const { chdirTestApp, resetEnv } = require('../helpers')
 const { resolve } = require('path')
 
 const rootPath = process.cwd()
 chdirTestApp()
 
-const config = require('../config')
+const config = require('../../package/config')
 
 describe('Config', () => {
  beforeEach(() => jest.resetModules() && resetEnv())
  afterAll(() => process.chdir(rootPath))
 
  test('public path', () => {
  process.env.RAILS_ENV = 'development'
- const config = require('../config')
+ const config = require('../../package/config')
  expect(config.publicPath).toEqual('/packs/')
  })
 
  test('public path with asset host', () => {
  process.env.RAILS_ENV = 'development'
  process.env.SHAKAPACKER_ASSET_HOST = 'http://foo.com/'
- const config = require('../config')
+ const config = require('../../package/config')
  expect(config.publicPath).toEqual('http://foo.com/packs/')
  })
 
@@ -40,7 +40,7 @@ describe('Config', () => {
 
  test('should allow overriding manifestPath', () => {
  process.env.SHAKAPACKER_CONFIG = 'config/shakapacker_manifest_path.yml'
- const config = require('../config')
+ const config = require('../../package/config')
  expect(config.manifestPath).toEqual(resolve('app/javascript/manifest.json'))
  })
 })

package/__tests__/dev_server.js → test/package/dev_server.test.js

@@ -1,6 +1,6 @@
 /* global test expect, describe */
 
-const { chdirTestApp } = require('../utils/helpers')
+const { chdirTestApp } = require('../helpers')
 
 const rootPath = process.cwd()
 chdirTestApp()
@@ -16,23 +16,23 @@ describe('DevServer', () => {
  process.env.SHAKAPACKER_DEV_SERVER_PORT = 5000
  process.env.SHAKAPACKER_DEV_SERVER_DISABLE_HOST_CHECK = false
 
- const devServer = require('../dev_server')
+ const devServer = require('../../package/dev_server')
  expect(devServer).toBeDefined()
  expect(devServer.host).toEqual('0.0.0.0')
  expect(devServer.port).toEqual('5000')
  expect(devServer.disable_host_check).toBe(false)
  })
 
  test('with custom env prefix', () => {
- const config = require('../config')
+ const config = require('../../package/config')
  config.dev_server.env_prefix = 'TEST_SHAKAPACKER_DEV_SERVER'
 
  process.env.NODE_ENV = 'development'
  process.env.RAILS_ENV = 'development'
  process.env.TEST_SHAKAPACKER_DEV_SERVER_HOST = '0.0.0.0'
  process.env.TEST_SHAKAPACKER_DEV_SERVER_PORT = 5000
 
- const devServer = require('../dev_server')
+ const devServer = require('../../package/dev_server')
  expect(devServer).toBeDefined()
  expect(devServer.host).toEqual('0.0.0.0')
  expect(devServer.port).toEqual('5000')
@@ -41,6 +41,6 @@ describe('DevServer', () => {
  test('with NODE_ENV and RAILS_ENV set to production', () => {
  process.env.RAILS_ENV = 'production'
  process.env.NODE_ENV = 'production'
- expect(require('../dev_server')).toEqual({})
+ expect(require('../../package/dev_server')).toEqual({})
  })
 })

package/__tests__/development.js → test/package/development.test.js

@@ -1,7 +1,7 @@
 /* test expect, describe, afterAll, beforeEach */
 
 const { resolve } = require('path')
-const { chdirTestApp, resetEnv } = require('../utils/helpers')
+const { chdirTestApp, resetEnv } = require('../helpers')
 
 const rootPath = process.cwd()
 chdirTestApp()
@@ -17,7 +17,7 @@ describe('Development environment', () => {
  process.env.RAILS_ENV = 'development'
  process.env.NODE_ENV = 'development'
  process.env.WEBPACK_SERVE = 'true'
- const { generateWebpackConfig } = require('../index')
+ const { generateWebpackConfig } = require('../../package/index')
 
  const webpackConfig = generateWebpackConfig()
 
@@ -29,7 +29,7 @@ describe('Development environment', () => {
  process.env.RAILS_ENV = 'development'
  process.env.NODE_ENV = 'development'
  process.env.WEBPACK_SERVE = undefined
- const { generateWebpackConfig } = require('../index')
+ const { generateWebpackConfig } = require('../../package/index')
 
  const webpackConfig = generateWebpackConfig()
 

package/__tests__/env.js → test/package/env.test.js

@@ -1,6 +1,6 @@
 /* global test expect, describe */
 
-const { chdirTestApp } = require('../utils/helpers')
+const { chdirTestApp } = require('../helpers')
 
 const rootPath = process.cwd()
 chdirTestApp()
@@ -12,7 +12,7 @@ describe('Env', () => {
  test('with NODE_ENV and RAILS_ENV set to development', () => {
  process.env.RAILS_ENV = 'development'
  process.env.NODE_ENV = 'development'
- expect(require('../env')).toEqual({
+ expect(require('../../package/env')).toEqual({
  railsEnv: 'development',
  nodeEnv: 'development',
  isProduction: false,
@@ -24,7 +24,7 @@ describe('Env', () => {
  test('with undefined NODE_ENV and RAILS_ENV set to development', () => {
  process.env.RAILS_ENV = 'development'
  delete process.env.NODE_ENV
- expect(require('../env')).toEqual({
+ expect(require('../../package/env')).toEqual({
  railsEnv: 'development',
  nodeEnv: 'production',
  isProduction: true,
@@ -36,7 +36,7 @@ describe('Env', () => {
  test('with undefined NODE_ENV and RAILS_ENV', () => {
  delete process.env.NODE_ENV
  delete process.env.RAILS_ENV
- expect(require('../env')).toEqual({
+ expect(require('../../package/env')).toEqual({
  railsEnv: 'production',
  nodeEnv: 'production',
  isProduction: true,
@@ -48,7 +48,7 @@ describe('Env', () => {
  test('with a non-standard environment', () => {
  process.env.RAILS_ENV = 'staging'
  process.env.NODE_ENV = 'staging'
- expect(require('../env')).toEqual({
+ expect(require('../../package/env')).toEqual({
  railsEnv: 'staging',
  nodeEnv: 'production',
  isProduction: true,

package/environments/__tests__/base.js → test/package/environments/base.test.js

@@ -3,15 +3,15 @@
 // environment.js expects to find config/shakapacker.yml and resolved modules from
 // the root of a Rails project
 
-const { chdirTestApp, chdirCwd, resetEnv } = require('../../utils/helpers')
+const { chdirTestApp, chdirCwd, resetEnv } = require('../../helpers')
 
 const rootPath = process.cwd()
 chdirTestApp()
 
 const { resolve } = require('path')
 
-const baseConfig = require('../base')
-const config = require("../../config");
+const baseConfig = require('../../../package/environments/base')
+const config = require("../../../package/config");
 
 describe('Base config', () => {
  beforeEach(() => jest.resetModules() && resetEnv())
@@ -30,7 +30,7 @@ describe('Base config', () => {
 
  test('should return true for css_extract_ignore_order_warnings when configured', () => {
  process.env.SHAKAPACKER_CONFIG = 'config/shakapacker_css_extract_ignore_order_warnings.yml'
- const config = require("../../config");
+ const config = require("../../../package/config");
 
  expect(config.css_extract_ignore_order_warnings).toEqual(true)
  })
@@ -47,8 +47,8 @@ describe('Base config', () => {
 
  test('should returns top level and nested entry points with config.nested_entries == true', () => {
  process.env.SHAKAPACKER_CONFIG = 'config/shakapacker_nested_entries.yml'
- const config = require("../../config");
- const baseConfig = require('../base')
+ const config = require("../../../package/config");
+ const baseConfig = require('../../../package/environments/base')
 
  expect(config.nested_entries).toEqual(true)
 
@@ -72,7 +72,7 @@ describe('Base config', () => {
  })
 
  test('should return default loader rules for each file in config/loaders', () => {
- const rules = require('../../rules')
+ const rules = require('../../../package/rules')
 
  const defaultRules = Object.keys(rules)
  const configRules = baseConfig.module.rules

package/environments/__tests__/development.js → test/package/environments/development.test.js

@@ -1,6 +1,6 @@
 /* global test expect, describe, afterAll, beforeEach */
 
-const { chdirTestApp, resetEnv } = require('../../utils/helpers')
+const { chdirTestApp, resetEnv } = require('../../helpers')
 const rootPath = process.cwd()
 chdirTestApp()
 
@@ -14,9 +14,9 @@ describe('Development specific config', () => {
 
  describe('with config.useContentHash = true', () => {
  test('sets filename to use contentHash', () => {
- const config = require("../../config");
+ const config = require("../../../package/config");
  config.useContentHash = true
- const environmentConfig = require('../development')
+ const environmentConfig = require('../../../package/environments/development')
 
  expect(environmentConfig.output.filename).toEqual('js/[name]-[contenthash].js')
  expect(environmentConfig.output.chunkFilename).toEqual(
@@ -27,9 +27,9 @@ describe('Development specific config', () => {
 
  describe('with config.useContentHash = false', () => {
  test('sets filename without using contentHash', () => {
- const config = require("../../config");
+ const config = require("../../../package/config");
  config.useContentHash = false
- const environmentConfig = require('../development')
+ const environmentConfig = require('../../../package/environments/development')
 
  expect(environmentConfig.output.filename).toEqual('js/[name].js')
  expect(environmentConfig.output.chunkFilename).toEqual(
@@ -40,9 +40,9 @@ describe('Development specific config', () => {
 
  describe('with unset config.useContentHash', () => {
  test('sets filename without using contentHash', () => {
- const config = require("../../config");
+ const config = require("../../../package/config");
  delete config.useContentHash
- const environmentConfig = require('../development')
+ const environmentConfig = require('../../../package/environments/development')
 
  expect(environmentConfig.output.filename).toEqual('js/[name].js')
  expect(environmentConfig.output.chunkFilename).toEqual(