fix(fta): change path handling

.github/workflows/ci.yml

@@ -56,7 +56,7 @@ jobs:
         id: test-action
         uses: ./
         with:
-          project_path: ../src/
+          project_path: ./src/
 
       - name: Print Output Summary
         id: output-summary

.gitignore

@@ -105,3 +105,4 @@ __tests__/runner/*
 # fta
 fta.config.json
 output.json
+tmp-config-file.json

README.md

@@ -57,7 +57,9 @@ jobs:
 
       - name: FTA GitHub Action
         id: fta-action
-        uses: exiguus/fta-github-action@v0.1.0
+        uses: exiguus/fta-github-action@v0.1.1
+        with:
+          config_path: fta.config.json
 
       - name: Print Output Summary
         id: output-summary
@@ -81,9 +83,9 @@ jobs:
 
 Path to the project to analyze
 
-**required**: true
+**required**: false
 
-**default**: "./src/"
+**default**: "src/"
 
 ### config_path
 
@@ -97,7 +99,7 @@ Path to output file
 
 **required**: false
 
-**default**: "./output.json"
+**default**: "output.json"
 
 ### format
 

__tests__/fta.test.ts

@@ -6,13 +6,6 @@ import * as fta from '../src/fta'
 import { expect } from '@jest/globals'
 
 describe('wait.ts', () => {
-  it('throws on invalid project_path', async () => {
-    const project_path = ''
-    await expect(fta.run(project_path)).rejects.toThrow(
-      'Param `project_path` does not exist'
-    )
-  })
-
   it('throws on non-existent project_path', async () => {
     const project_path = 'non-existent-file'
     await expect(fta.run(project_path)).rejects.toThrow(

action.yml

@@ -17,15 +17,15 @@ branding:
 inputs:
   project_path:
     description: 'Path to the project to analyze'
-    required: true
-    default: './src/'
+    required: false
+    default: 'src/'
   config_path:
     description: 'Path to config file'
     required: false
   output_path:
     description: 'Path to output file'
     required: false
-    default: './output.json'
+    default: 'output.json'
   format:
     description:
       'Output format (default: table) [default: table] [possible values: table,

package.json

@@ -45,9 +45,9 @@
     "lint:fix": "npm run lint:fix:eslint && npm run lint:fix:markdownlint",
     "package": "npx ncc build src/index.ts --license licenses.txt",
     "package:watch": "npm run package -- --watch",
-    "test": "npm run test:unit && npm run test:output",
+    "test": "export GITHUB_WORKSPACE=$(pwd) && npm run test:unit && npm run test:output",
     "test:unit": "npx jest",
-    "test:output": "node dist/index.js >/dev/null && diff output.json __mocks__/output.json || exit 1",
+    "test:output": "export GITHUB_WORKSPACE=$(pwd) && node dist/index.js >/dev/null && diff output.json __mocks__/output.json || exit 1",
     "all": "npm run format && npm run lint && npm run test && npm run coverage && npm run package",
     "prepare": "husky install"
   },

src/fta/config.test.ts

@@ -77,7 +77,7 @@ describe('writeConfig function', () => {
     writeConfig(configPath, validConfigMock)
 
     expect(fs.writeFileSync).toHaveBeenCalledWith(
-      path.join(__dirname, configPath),
+      path.join(process.env.GITHUB_WORKSPACE || '', configPath),
       JSON.stringify(validConfigMock, null, 2),
       { encoding: 'utf8' }
     )

src/fta/config.ts

@@ -19,7 +19,10 @@ export const getConfig = (
 ): Partial<ActionOptions> | null => {
   try {
     const config = JSON.parse(
-      fs.readFileSync(path.join(__dirname, config_path), 'utf8')
+      fs.readFileSync(
+        path.join(process.env.GITHUB_WORKSPACE || '', config_path),
+        'utf8'
+      )
     )
     return isActionOptions(config) ? config : null
   } catch (error) {
@@ -39,7 +42,7 @@ export const writeConfig = (
 ): void => {
   try {
     fs.writeFileSync(
-      path.join(__dirname, config_path),
+      path.join(process.env.GITHUB_WORKSPACE || '', config_path),
       JSON.stringify(options, null, 2),
       { encoding: 'utf8' }
     )

src/fta/options.ts

@@ -1,7 +1,7 @@
 import { ActionInput, ActionOptions, Formats, OptionsMap } from './types'
 
 export const defaultInput: ActionInput = {
-  filePath: '../src/',
+  projectPath: '/src/',
   configPath: '',
   outputPath: 'output.json',
   format: 'json',

src/fta/output.test.ts

@@ -3,7 +3,7 @@ import path from 'path'
 import { writeOutput } from './output'
 
 describe('writeOutput function', () => {
-  const outputFilePath = '../dist/test-output.json'
+  const outputFilePath = './dist/test-output.json'
   const testData = '{"key": "value"}'
 
   it('should write data to the specified output file', () => {
@@ -14,7 +14,7 @@ describe('writeOutput function', () => {
 
     // Check if fs.writeFileSync was called with the expected arguments
     expect(spyWriteFileSync).toHaveBeenCalledWith(
-      path.join(__dirname, '..', outputFilePath),
+      path.join(process.env.GITHUB_WORKSPACE || '', outputFilePath),
       testData,
       { encoding: 'utf8' }
     )

src/fta/output.ts

@@ -3,10 +3,13 @@ import path from 'path'
 
 export const writeOutput = (output_path: string, data: string): void => {
   try {
-    // write output file into ../dist
-    fs.writeFileSync(path.join(__dirname, '..', output_path), data, {
-      encoding: 'utf8'
-    })
+    fs.writeFileSync(
+      path.join(process.env.GITHUB_WORKSPACE || '', output_path),
+      data,
+      {
+        encoding: 'utf8'
+      }
+    )
   } catch (error) {
     throw new Error('Error writing output file')
   }

src/fta/run.test.ts

@@ -37,13 +37,17 @@ describe('run function', () => {
 
     // Check if fs.existsSync and other functions were called with the expected arguments
     expect(mockFsExistsSync).toHaveBeenCalledWith(
-      expect.stringContaining(path.join(__dirname, defaultInput.filePath))
+      expect.stringContaining(
+        path.join(process.env.GITHUB_WORKSPACE || '', defaultInput.projectPath)
+      )
     )
     expect(mockFsExistsSync).toHaveBeenCalledWith(
       expect.stringContaining(defaultInput.configPath)
     )
     expect(mockFsExistsSync).toHaveBeenCalledWith(
-      expect.stringContaining(path.join(__dirname, defaultInput.filePath))
+      expect.stringContaining(
+        path.join(process.env.GITHUB_WORKSPACE || '', defaultInput.projectPath)
+      )
     )
 
     expect(mockWriteConfig).toHaveBeenCalledWith(

src/fta/run.ts

@@ -27,7 +27,7 @@ export async function run(
   options: Partial<ActionOptions> | null = null
 ): Promise<ActionOutput> {
   if (!project_path) {
-    project_path = defaultInput.filePath
+    project_path = defaultInput.projectPath
   }
   if (!config_path) {
     config_path = defaultInput.configPath
@@ -36,7 +36,9 @@ export async function run(
     output_path = defaultInput.outputPath
   }
 
-  if (!fs.existsSync(path.join(__dirname, project_path)))
+  if (
+    !fs.existsSync(path.join(process.env.GITHUB_WORKSPACE || '', project_path))
+  )
     throw new Error('Param `project_path` does not exist')
 
   // use --format over --json shorthand fta cli cmd
@@ -52,7 +54,7 @@ export async function run(
   if (config_path.length > 0) {
     // throw if config path does not exist
     try {
-      fs.existsSync(path.join(__dirname, config_path))
+      fs.existsSync(path.join(process.env.GITHUB_WORKSPACE || '', config_path))
     } catch (error) {
       throw new Error('Param `config_path` does not exist')
     }
@@ -70,7 +72,11 @@ export async function run(
       throw new Error('Param `config_path` is not a json file')
     }
     try {
-      if (!fs.lstatSync(path.join(__dirname, config_path)).isFile())
+      if (
+        !fs
+          .lstatSync(path.join(process.env.GITHUB_WORKSPACE || '', config_path))
+          .isFile()
+      )
         throw new Error('Param `config_path` is not a file')
     } catch (error) {
       throw new Error('Param `config_path` is not a file')
@@ -146,15 +152,21 @@ export async function run(
   // output
   // details is the output of the fta command with the format option
   //  details are also saved to a file in the github action
-  const configFile = path.join(__dirname, TMP_CONFIG_FILE)
-  const filePath = path.join(__dirname, project_path)
+  const configFile = path.join(
+    process.env.GITHUB_WORKSPACE || '',
+    TMP_CONFIG_FILE
+  )
+  const projectPath = path.join(
+    process.env.GITHUB_WORKSPACE || '',
+    project_path
+  )
   const details = execSync(
-    `npm exec --package=fta-cli -c 'fta ${filePath} --config-path ${configFile} --format ${mappedOptions.format}'`
+    `npm exec --package=fta-cli -c 'fta ${projectPath} --config-path ${configFile} --format ${mappedOptions.format}'`
   ).toString()
   // summary is the output of the fta command with the table format option
   //  to have a quick look at the results
   const summary = execSync(
-    `npm exec --package=fta-cli -c 'fta ${filePath} --config-path ${configFile} --format table'`
+    `npm exec --package=fta-cli -c 'fta ${projectPath} --config-path ${configFile} --format table'`
   ).toString()
 
   if (output_path) {

src/fta/types.ts

@@ -44,7 +44,7 @@ export type ActionOptions = Record<
 >
 
 export type ActionInput = {
-  filePath: string
+  projectPath: string
   configPath: string
   outputPath: string
 } & Record<