tutorial.test.ts

import * as T from '../typings/tutorial'
import tutorialSchema from '../src/schema/tutorial'
import { validateSchema } from '../src/utils/validateSchema'

const validJson: Partial<T.Tutorial> = {
  id: 'coderoad-test',
  version: '0.1.0',
  summary: { title: 'Title', description: 'Description' },
  config: {
    testRunner: {
      command: 'aCommand',
      args: {
        filter: 'filter',
        tap: 'tap'
      },
      directory: 'coderoad'
    },
    setup: {
      commits: ['abcdef1'],
      commands: ['npm install']
    },
    repo: {
      uri: 'https://github.com/some-repo.git',
      branch: 'someBranch'
    },
    dependencies: [{ name: 'name', version: '>=1' }],
    appVersions: {
      vscode: '>=0.7.0'
    },
    webhook: {
      url: 'https://example.com/webhook',
      events: {
        init: true,
        reset: false,
        step_complete: false,
        level_complete: false,
        tutorial_complete: true,
      }
    },
  },
  levels: [
    {
      id: '1',
      title: 'Level 1',
      summary: 'The first level',
      content: 'The first level',
      steps: [
        {
          id: '1.1',
          content: 'The first step',
          setup: { commits: ['abcdefa'] },
          solution: { commits: ['abcdefb'] }
        }
      ]
    }
  ]
}

const validateTutorial = (json: any) => validateSchema(tutorialSchema, json)

describe('validate tutorial', () => {
  it('should reject an empty tutorial', () => {
    const json = { version: 'here' }

    const valid = validateTutorial(json)
    expect(valid).toBe(false)
  })
  it('should return true for a valid tutorial', () => {
    const valid = validateTutorial({ ...validJson })
    expect(valid).toBe(true)
  })
  it('should return true for a tutorial with no level content', () => {
    const json = {
      ...validJson,
      levels: [
        {
          id: '1',
          title: 'Level 1',
          summary: '',
          content: '',
          steps: []
        }
      ]
    }

    const valid = validateTutorial(json)
    expect(valid).toBe(true)
  })
  it('should allow a step with no solution', () => {
    const json = {
      ...validJson,
      levels: [
        {
          id: '1',
          title: 'Level 1',
          summary: 'summary',
          content: 'content',
          steps: [
            {
              id: '1.1',
              content: 'The first step',
              setup: { commits: ['abcdefa'] }
            },
            {
              id: '1.2',
              content: 'The second step',
              setup: { commits: ['abcdefb'] }
            }
          ]
        }
      ]
    }

    const valid = validateTutorial(json)
    expect(valid).toBe(true)
  })
  it("shouldn't allow a step with no setup but a solution", () => {
    const json = {
      ...validJson,
      levels: [
        {
          id: '1',
          title: 'Level 1',
          summary: 'summary',
          content: 'content',
          steps: [
            {
              id: '1.1',
              content: 'The first step',
              solution: { commits: ['abcdefa'] }
            },
            {
              id: '1.2',
              content: 'The second step',
              solution: { commits: ['abcdefb'] }
            }
          ]
        }
      ]
    }

    const valid = validateTutorial(json)
    expect(valid).toBe(false)
  })
})