lint/src/rules/file/hasDoxygenHeader.spec.ts

import { LintConfig } from '../../types'
import { Severity } from '../../types/Severity'
import { hasDoxygenHeader } from './hasDoxygenHeader'

describe('hasDoxygenHeader - test', () => {
  it('should return an empty array when the file starts with a doxygen header', () => {
    const content = `/**
   @file
   @brief Returns an unused libref
 **/

 %macro mf_getuniquelibref(prefix=mclib,maxtries=1000);
   %local x libref;
   %let x={SAS002};
   %do x=0 %to &maxtries;`

    expect(hasDoxygenHeader.test(content)).toEqual([])
  })

  it('should return an empty array when the file starts with a doxygen header', () => {
    const content = `
    
    
    /*
   @file
   @brief Returns an unused libref
 */

 %macro mf_getuniquelibref(prefix=mclib,maxtries=1000);
   %local x libref;
   %let x={SAS002};
   %do x=0 %to &maxtries;`

    expect(hasDoxygenHeader.test(content)).toEqual([
      {
        message:
          'File not following Doxygen header style, use double asterisks',
        lineNumber: 4,
        startColumnNumber: 1,
        endColumnNumber: 1,
        severity: Severity.Warning
      }
    ])
  })

  it('should return an array with a single diagnostic when the file has no header', () => {
    const content = `
 %macro mf_getuniquelibref(prefix=mclib,maxtries=1000);
   %local x libref;
   %let x={SAS002};
   %do x=0 %to &maxtries;`

    expect(hasDoxygenHeader.test(content)).toEqual([
      {
        message: 'File missing Doxygen header',
        lineNumber: 1,
        startColumnNumber: 1,
        endColumnNumber: 1,
        severity: Severity.Warning
      }
    ])
  })

  it('should return an array with a single diagnostic when the file has comment blocks but no header', () => {
    const content = `
 %macro mf_getuniquelibref(prefix=mclib,maxtries=1000);
   %local x libref;
   %let x={SAS002};
  /** Comment Line 1
   * Comment Line 2
   */
   %do x=0 %to &maxtries;`

    expect(hasDoxygenHeader.test(content)).toEqual([
      {
        message: 'File missing Doxygen header',
        lineNumber: 1,
        startColumnNumber: 1,
        endColumnNumber: 1,
        severity: Severity.Warning
      }
    ])
  })

  it('should return an array with a single diagnostic when the file is undefined', () => {
    const content = undefined

    expect(hasDoxygenHeader.test(content as unknown as string)).toEqual([
      {
        message: 'File missing Doxygen header',
        lineNumber: 1,
        startColumnNumber: 1,
        endColumnNumber: 1,
        severity: Severity.Warning
      }
    ])
  })
})

describe('hasDoxygenHeader - fix', () => {
  it('should not alter the text if a doxygen header is already present', () => {
    const content = `/**
   @file
   @brief Returns an unused libref
 **/

 %macro mf_getuniquelibref(prefix=mclib,maxtries=1000);
   %local x libref;
   %let x={SAS002};
   %do x=0 %to &maxtries;`

    expect(hasDoxygenHeader.fix!(content)).toEqual(content)
  })

  it('should update single asterisks to double if a doxygen header is already present', () => {
    const contentOriginal = `
    /*
   @file
   @brief Returns an unused libref
 */

 %macro mf_getuniquelibref(prefix=mclib,maxtries=1000);
   %local x libref;
   %let x={SAS002};
   %do x=0 %to &maxtries;`

    const contentExpected = `
    /**
   @file
   @brief Returns an unused libref
 */

 %macro mf_getuniquelibref(prefix=mclib,maxtries=1000);
   %local x libref;
   %let x={SAS002};
   %do x=0 %to &maxtries;`

    expect(hasDoxygenHeader.fix!(contentOriginal)).toEqual(contentExpected)
  })

  it('should add a doxygen header if not present', () => {
    const content = `%macro mf_getuniquelibref(prefix=mclib,maxtries=1000);
%local x libref;
%let x={SAS002};
%do x=0 %to &maxtries;`

    expect(hasDoxygenHeader.fix!(content)).toEqual(
      `/**
  @file
  @brief <Your brief here>
  <h4> SAS Macros </h4>
**/` +
        '\n' +
        content
    )
  })

  it('should use CRLF line endings when configured', () => {
    const content = `%macro mf_getuniquelibref(prefix=mclib,maxtries=1000);\n%local x libref;\n%let x={SAS002};\n%do x=0 %to &maxtries;`
    const config = new LintConfig({ lineEndings: 'crlf' })

    expect(hasDoxygenHeader.fix!(content, config)).toEqual(
      `/**\r\n  @file\r\n  @brief <Your brief here>\r\n  <h4> SAS Macros </h4>\r\n**/` +
        '\r\n' +
        content
    )
  })
})